gotson/komga-website

Official website for Komga

komga-website's Issues

Document how to setup JVM memory limits

Add faq entry for tachiyomi and cloudflare

When using the dns over https option from tachiyomi, local server can't be resolved, but is working fine in web view.

[Bug] Website is providing a hyperlink to configuration environment variable which leads to 404

Komga website refers to docker environment configuration, but hyperlink ends in 404

FreeNAS/TrueNAS Jails Tutorial linked in installation is outdated / obsolete

The FreeNAS tutorial linked on the website doesn't seem to work for me in TrueNAS 12, possibly due to changes in the OS since the guide was made. The specific issues I've encountered occur when starting/stopping the Komga jail. IOCAGE stops functioning and prevents other jails from starting up/shutting down resulting in a lot of challenges.

I wanted to figure out a way around these issues so I wrote a config file for PM2 to run Komga on jail startup. Other benefits of PM2 include showing you the status of your Komga server and the resources it's currently using with simple commands.

I think there may be a way to get Komga to start natively with an rc script but I'm unfamiliar with that system and couldn't find a guide or similar solutions that successfully worked for me. I'm certain there are other methods I've overlooked as well!

---

Here's my own tutorial that begins from jail creation. You can just skip ahead if you already have one running with pm2 installed already:

Create a pkg.json file containing everything your jail needs to install and run Komga.

echo '{"pkgs":["openjdk11-jre","nano","ca_root_nss","yarn"]}' > /tmp/pkg.json

Using that file we just made, create the jail with IOCAGE. Replace <KOMGA> with the IP you want the Komga server to have on your network and <ROUTER> with the address of your network's router.

iocage create -n "komga" -p /tmp/pkg.json -r 12.2-RELEASE ip4_addr="vnet0|<KOMGA>/24" defaultrouter="<ROUTER>" vnet="on" allow_raw_sockets="1" boot="on"

We can now safely delete that file we created earlier.

rm /tmp/pkg.json

Make a config directory to store Komga, its config files, the database and logs.

iocage exec komga mkdir -p /config/komga

Make the comics directory where Komga will find your comics.

iocage exec komga mkdir -p /comics

Link the config directory we just made to a safe location outside of the jail in case you want to destroy and remake the jail later without losing your database and logs. Make sure to replace <STORAGE> with a location you're comfortable with.

iocage fstab -a komga /mnt/<STORAGE>/komga /config nullfs rw 0 0

Link the comics directory we made earlier to the comics directory stored on your TrueNAS server so Komga can read and write them. If you only want Komga to read your files, but not write to them, you can change "rw" to "ro".

iocage fstab -a komga /mnt/<COMICS_DIR> /comics nullfs rw 0 0

Next we must stop the jail, set its mounting options for java 11 to work properly and restart the jail.

iocage stop komga
iocage set mount_fdescfs=1 komga
iocage set mount_procfs=1 komga
iocage start komga

Download Komga to the jail and make it executable.

iocage exec komga fetch https://github.com/gotson/komga/releases/download/v0.106.1/komga-0.106.1.jar -o /config/komga/komga-latest.jar
iocage exec komga chmod u+x /config/komga/komga-latest.jar

Next we install PM2 and tell it to startup with the jail automatically.

iocage exec komga yarn global add pm2
iocage exec komga pm2 startup

Now we create both the application.yml file Komga requires and the ecosystem.config.js file PM2 requires:

iocage exec komga nano

Paste the below into nano after you've modified the values as needed according to the website's instructions and save the file to /config/komga/application.yml:

komga:
  remember-me:
    key: somerandomkey1245
    validity: 2592000
  database:
    file: /config/komga/database.sqlite
server:
  port: 80
logging:
  file:
    name: /config/komga/komga.log
    max-history: 5

Paste the below into nano and save the file as /config/komga/ecosystem.config.js:

module.exports = {
     "apps":[
       {
            "name":"Komga",
            "script":"java",
            "cwd":"/config/komga",
            "args":[
                "-jar",
                "/config/komga/komga-latest.jar"
            ],
            "watch":[
                "/config/komga/komga-latest.jar"
            ],
            "node_args":[],
            "log_date_format":"YYYY-MM-DD HH:mm Z",
            "exec_interpreter":"none",
            "exec_mode":"fork"
        }
    ]
}

Run Komga and save your settings:

iocage exec komga pm2 start /config/komga/ecosystem.config.js
iocage exec komga pm2 save

If you want to see the status of the Komga server you can use this command:

iocage exec komga pm2 status

Or to restart Komga, use:

iocage exec komga pm2 restart Komga

You can find a whole list of commands and more documentation on PM2's configuration file here.

Komga is now accessible from the LAN IP you used to make the jail and the port number you used in application.yml. Enjoy!

Missing mention of Volume import in series title

Change wording for removed features

removed from vX is not very clear, we should use removed since vX instead.

Document webreader keyboard shortcuts

Add useful tools / komf section to website

Describe your suggested feature

For a lot of people komf can be a very useful tool, but it is relatively obscure for new users since there are not a lot of references anywhere.

It would be nice if there could be a small section on the official website describing it or a general assortment of tools with komga integration/metadata and other management.

Other details

No response

Acknowledgements

• I have searched the existing issues and this is a new ticket, NOT a duplicate or related to another open issue.
• I have written a short but informative title.
• I have updated the app to the latest version.
• I will fill out all of the requested information in this form.

Issue with link on paperback.md

https://github.com/gotson/komga-website/blob/master/website/docs/guides/paperback.md

the extension ver 1.2.10 seems to be broken, you need to use version 1.2.12
the komga website links to the 1.2.10 extentsion.

using ver 1.2.10 was giving me a 401 error when logging in.

Add FAQ section

• cache expiry during scan
• Java OOM exceptions

Add panels (ios) as an OPDS reader.

Works great, and is the nicest looking comic client on iOS, even shows up as komga with an icon and everything

Should be added to this page https://komga.org/guides/opds.html

Add information about supported file formats and directory structure

Windows symlinks under docker

Describe your suggested feature

With Windows Docker Desktop 4.7.1 (77678) and previous it is NOT possible to use symlinks.

This request is only for documentation when somebody find/has the same issue.

Example:
with mklink /d targetdirectory sourcedirectory you can create symlinks under windows.
So you can create a filestructure with folders.

This will not work under windows docker and so also not work under Komga. This is NO Komga issue. It is a docker issue.

Please look into docker documentation and issue tracking.

Other details

No response

Acknowledgements

• I have searched the existing issues and this is a new ticket, NOT a duplicate or related to another open issue.
• I have written a short but informative title.
• I have updated the app to the latest version.
• I will fill out all of the requested information in this form.