# How to host a remote Kavita e-book server
## Introduction
[Kavita](https://www.kavitareader.com/) is a multi-platform, open-source digital library server. It allows you to import your e-book collection and then conveniently access it from any device. Such a setup eliminates the need for downloading files on different devices and keeping track of your progress on each one.
Since the Kavita server is web-based, it can be easily shared between peers. However, leaving your home network open for remote access can be considered a vulnerability and be exploited for malicious intents.
By using [Meshnet](https://nordvpn.com/meshnet/), you don’t have to set up [port forwarding](https://nordvpn.com/blog/port-forwarding/) or manually configure a [VPN connection](https://nordvpn.com/what-is-a-vpn/). Meshnet uses encrypted network tunnels to connect devices into a single virtual network allowing secure, unrestricted remote connections.
This article demonstrates how you can self-host a Kavita server for your digital book collection using Docker and remotely connect to the server via Meshnet.
## Prerequisites
Before you begin, ensure you have [Docker](https://docs.docker.com/get-started/overview/) and [Docker Compose](https://docs.docker.com/compose/) installed on your device. You can find instructions on how to download and install these tools on the Docker website:
* [Docker Desktop instructions for Windows](https://docs.docker.com/desktop/install/windows-install/)
* [Docker Desktop instructions for macOS](https://docs.docker.com/desktop/install/mac-install/)
* [Docker Desktop Instructions for Linux](https://docs.docker.com/desktop/install/linux-install/)
* [Docker Engine instructions for Linux (CLI only)](https://docs.docker.com/engine/install/)
* [Docker Compose instructions for Linux (CLI only)](https://docs.docker.com/compose/install/linux/)
{% hint style="info" %}
**Note**
Docker Compose comes pre-installed with Docker Desktop.
{% endhint %}
## Create your Kavita instance using Docker
You can begin preparing your Kavita server once you have Docker running on your device.
### Prepare a Docker Compose file
To start, you have to define the instructions for deploying the Kavita instance. This is done in the form of a Docker Compose file.
{% tabs %}
{% tab title="Windows" %}
1. Open **PowerShell**.
2. In your preferred directory, make a new `kavita` folder and navigate to it using the following command:\
mkdir kavita; cd kavita
3. Create a `docker-compose.yml` file and open it using Notepad by running:\
notepad docker-compose.yml
When prompted to create the file, click **Yes**.
4. In **Notepad**, paste the following instructions for the Kavita Docker container:\
5. Update the placeholders with the values relevant to your configuration:
* Replace `<\path\to\e-books>` with the path to your e-book folder.
* Replace `` with your [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\
**Example**
6. Press **Ctrl** + **S** to save changes.
7. Exit **Notepad**.
{% hint style="success" %}
**Tip**
If you want to include additional folders, such as comic books and manga, you can append new lines under the `volumes` section. For example:
```yaml
- <\path\to\comics>:/comics
- <\path\to\manga>:/manga
```
{% endhint %}
{% endtab %}
{% tab title="macOS and Linux" %}
1. Open **Terminal**.
2. In your preferred directory, make a new `kavita` folder and navigate to it using the following command:\
mkdir kavita && cd kavita
3. Create a `docker-compose.yml` file and open it using the Nano text editor by running:\
nano docker-compose.yml
4. In the compose file, paste the following instructions for the Kavita Docker container:\
5. Update the placeholders with the values relevant to your configuration:
* Replace `` with the path to your e-book folder.
* Replace `` with your [time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List).\
**Example**
6. Press **Ctrl** + **X**, **Y**, and **Enter** to save changes and exit the text editor.
{% hint style="success" %}
**Tip**
If you want to include additional folders, such as comic books and manga, you can append new lines under the `volumes` section. For example:
{% code overflow="wrap" %}
```yaml
- :/comics
- :/manga
```
{% endcode %}
{% endhint %}
{% endtab %}
{% endtabs %}
### Deploy the Kavita container
Now, you can use the instructions declared in the compose file to create your Kavita server instance. To deploy the container, while in the `kavita` directory, run the following command:
{% code overflow="wrap" %}
```bash
docker compose up -d
```
{% endcode %}
Docker will [pull the Kavita image](https://docs.docker.com/engine/reference/commandline/pull/) from [Docker Hub](https://hub.docker.com/r/jvmilazz0/kavita) and deploy the container.
### Verify the container status
Run the `docker ps` command to check the state of the container. In the output, under `STATUS`, you should see `Up` and the duration indicating how long the container has been active.
## Personalize your Kavita server
The Kavita server is controlled and used directly from a web interface which is created when the service is deployed.
### Set up an administrator user
To start using the server, you need to create an administrator account. This account will have all of the permissions to manage the server.
1. Open your internet browser.
2. Navigate to the following URL:\
\
`localhost:5000/`\
3. Fill in the following details:
* In the **Username** field, enter a custom username for the administrator account.
* In the **Email** field, type in an email address that should be associated with the administrator user.
* In the **Password** field, enter a strong password that will be used for administrator authentication.
4. Click **Register**.
5. On the login page, enter your newly created authentication details and click **Submit.**
You should now see the home page of the Kavita web interface.
### Add your e-book library
Currently, your Kavita server does not display any e-books present in the folder you provided when deploying the Docker container. To fix this, you need to create a new library and point it to the location of your e-book collection.
1. On the Kavita web interface, in the upper-right corner, click **Server settings**.
2. Select the **Libraries** tab and click **Add library.**
3. In the **Name** field, enter a custom name for the new library.
4. From the **Type** dropdown list, select **Book**, and click **Next**.
5. Click **Browse for media folders**.
6. Select `/`, then `books`, and click **Share**.
7. Click **Next** twice and then **Save** to finish.
The newly added folder should now be visible under **Libraries**.
{% hint style="info" %}
**Note**
Ensure that your e-book folder structure follows the requirements provided in the [Kavita documentation](https://wiki.kavitareader.com/guides/scanner/#file-layout). Otherwise, the server may not detect your e-books.
{% endhint %}
### Turn on automatic library scans
To make sure that your libraries are updated as soon as possible, you can enable the "Folder watching" feature of Kavita. It will monitor your library folders for any changes and update them when necessary.
1. Open the **Server settings** page.
2. In the **General** tab, scroll down to the **Folder watching**.
3. Turn on the **Enable folder watching** toggle.
4. Click **Save**.
### Invite additional users
If you wish to share access to the Kavita server with your friends or family, it is advisable to have distinct accounts for each user. Kavita has a user management system that allows you to send invitation links or manually create accounts yourself.
To create a new user account:
1. Open Kavita **Server settings**.
2. Select the **Users** tab and click **Invite**.
3. In the **Email field**, enter a username for the new user account.
4. Select the roles and libraries you want the new account to have access to and click **Invite**.
You should now see a registration link in the **Invite url** field. From here, you can choose if you want to finish the new user creation yourself or send the invitation link to your Meshnet peer.
Complete account setup
To finish the user creation process yourself:
1. Copy the provided URL.
2. Open a new tab in your browser.
3. Paste the copied link in the URL field.
4. Fill in the **Username** and **Password** fields, and click **Register**.
A notification claiming **Account registration complete** should prompt.
Send invitation
To send an invitation to your Meshnet peer:
1. Copy the provided URL.
2. Change the `localhost` part of the link to the Nord name of your Kavita server.\
\
**Example**
3. Share the updated link with your peer.
After opening the link, the invitee will need to fill in the registration details and create the account.
## Remotely access your e-books with Meshnet
Your Kavita e-book server is now fully set up and ready for use. You can remotely connect to the server over Meshnet by either using a third-party e-book reader app or directly from your internet browser.
{% hint style="info" %}
**Note**
If you're hosting Kavita on a Linux device, you must grant the [local network permission](https://meshnet.nordvpn.com/features/explaining-permissions/local-network-permissions) for the devices accessing it. For more information, see [Common issues on Linux](https://meshnet.nordvpn.com/troubleshooting/linux#cannot-access-docker-containers-over-meshnet).
{% endhint %}
### Method 1: Using mobile reader apps
This section contains instructions for connecting to the Kavita server using the [Moon+ Reader](https://www.moondownload.com/) app on Android as an example.
You can download and install Moon+ Reader for free from [Google Play](https://play.google.com/store/apps/details?id=com.flyersoft.moonreader\&hl=en\&gl=US). After installing the app:
1. Copy the Nord name of the device hosting the Kavita server from the NordVPN app.
2. Launch **Moon+ Reader**.
3. If prompted, grant the **All files access** permission to the reader app.
4. Tap the arrow icon in the upper-right corner of the **Net library** section.
5. In the upper-right corner, tap the three-dot icon and select **Add new catalog**.
6. Fill in the following details:
* In the **Catalog name** field, enter a custom name for the Kavita library that will be displayed in the reader.
* In the **Catalog URL** field, type in `http://`, paste the copied Nord name, and add `:5000/`.\
**Example**\
`http://secret.meerkat-himalayas.nord:5000`\
7. Tap **OK**.
Your Kavita library should now be visible on the **Net library** screen.
### Method 2: Using an internet browser
To access your e-book library on the Kavita server from an internet browser:
1. Copy the Nord name of the device hosting the Kavita server.
2. Open your internet browser.
3. In the URL field, paste the copied Nord name, add `:5000/`, and press **Enter**.\
\
**Example**\
`secret.meerkat-himalayas.nord:5000/`\
4. Type in the username and password of the Kavita user account.
5. Click **Submit** to log in.
Now you can access your digital e-book library from the comfort of your internet browser.
