Skip to content

Commit

Permalink
faq tweaks and linux service file
Browse files Browse the repository at this point in the history
added info based on community feedback
  • Loading branch information
DieselTech committed Feb 6, 2024
1 parent d61fec6 commit 119a874
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 1 deletion.
36 changes: 36 additions & 0 deletions pages/installation/native.mdx
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
import { SYSTEM_ENTRYPOINTS } from 'next/dist/shared/lib/constants'
import { Callout } from 'nextra-theme-docs'
import { Steps } from 'nextra/components'
import { Tabs } from 'nextra/components'
Expand All @@ -24,6 +25,34 @@ Use `chmod` and `chown` commands so Kavita can write to the directory you placed
### Step 4

Run Kavita executable. Usually `./Kavita`

### Setup Kavita as a service (Optional)

To have Kavita start in the background at boot, you may install it as a systemd service. Save the following to a file named `kavita.service` in the directory /etc/systemd/system

<Callout type="info">
This file is an example and assumes you have installed Kavita in /opt/Kavita and you are running it as a separate user. Make sure to customize it to your own syetem.
</Callout>

```bash copy
[Unit]
Description=Kavita Server
After=network.target

[Service]
User=kavita
Group=kavita
Type=simple
WorkingDirectory=/opt/Kavita
ExecStart=/opt/Kavita/Kavita
TimeoutStopSec=20
KillMode=process
Restart=on-failure

[Install]
WantedBy=multi-user.target
```

</Steps>
</Tabs.Tab>
<Tabs.Tab>
Expand Down Expand Up @@ -60,6 +89,13 @@ Disable Gatekeeper for Kavita's folder so that Kavita and all .dll and .dylib fi
xattr -r -d com.apple.quarantine ~/Kavita/
```

Forgetting to disable Gatekeeper will prevent Kavita from running!
If you get this screen:
![Gatekeeper](/../public/installation/osx-gatekeeper.png "Gatekeeper warning")

That means the command wasn't ran on the right folder.


### Step 5
```bash
export alias sqlite=sqlite3
Expand Down
8 changes: 7 additions & 1 deletion pages/troubleshooting/faq.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,13 @@ A. No, Kavita uses filenames and internal metadata for parsing and is not design
A. Kavita uses NetVips for cover generation and thus requires SSE4.2 instruction set. Generally, Core i3/i5/i7/i9 support them, whereas Pentium and Celeron CPUs do not. CPUs from 2011 onwards should support SSE4.2. You can read more about it [here](https://github.com/kleisauke/net-vips/issues/176). If you fall in this category and still want to use Kavita, you can delete the libvips.dll or libvips.so and install it (`libvips-tools` for Linux) via your system manager (version must < v8.10.6) or compile it yourself, see this issue [here](https://github.com/Kareadita/Kavita/issues/1423).

#### Q. I'm seeing database is locked errors in my logs
A. This can happen on some configurations. An easy solution is to turn on WAL mode, which Kavita supports out of the box. To do this, open your sqlite file and run `PRAGMA journal_mode=WAL;` while Kavita is not running. An easy tool to do this is [DB Browser for SQLite](https://sqlitebrowser.org/)
A. This can happen on some configurations. An easy solution is to turn on WAL mode, which Kavita supports out of the box. To do this, open your sqlite file (after stopping kavita) and run `PRAGMA journal_mode=WAL;`. An easy tool to do this is [DB Browser for SQLite.](https://sqlitebrowser.org/)

For CLI users you can run the command below if your platform has the needed sqlite3 tools installed.

```bash copy
sqlite3 kavita.db 'PRAGMA journal_mode=WAL;
```
#### Q. Is there an app? I don't want to use the website.
Kavita does not yet offer mobile apps, however you can "Add to Home screen" our website, which will create an icon on your mobile device and launch the site in fullscreen mode. If that doesn't work for you, you can use a supported external reader, found [here](https://wiki.kavitareader.com/faq/external-readers).
Expand Down
Binary file added public/installation/osx-gatekeeper.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 119a874

Please sign in to comment.