Skip to content

Latest commit

 

History

History
50 lines (35 loc) · 2.48 KB

deployment.md

File metadata and controls

50 lines (35 loc) · 2.48 KB
Raw

How to deploy Nagato-Manga on your server

Docker deployment (recommanded)

Set up the container

The Docker image for the API is available on Docker Hub.

You can deploy the container with the following command that will expose the API on port 8000 :

docker run -d \
    --name nagato-api \
    -p 8000:8090 \
    -v /path/to/downloads:/data \
    -v /path/to/config:/opt/nagato-api/config \
    -v /path/to/database:/opt/nagato-api/nagato.db \
    elpain/nagato-api:latest

By default there is only one destination folder for all downloads, which is /data. This can change however if you edit the configuration file, as you can define a specific destination folder for any downloader. When you tweak such parameters, make sure to edit the binds and mounts accordingly.

As for the configuration file themselves, you don't necessarily have to modify them. You can set most global configuration with environment variables, so you will only have to meddle with the configuration files if you want to have a different configuration for a specific downloader (more details here). The configuration files will be created at the first launch of the API if they don't exist yet. You can also copy the json files in the default configuration and put them in the folder that will be mapped onto /opt/nagato-api/config. If you switch to a newer version of the API with configuration entries that don't exist in your files, they will be added automatically.

Alternatively, you can use docker-compose. An example file equivalent to the code above is available here.

Build the Docker image

You can also build the image yourself if you want.

Make sure you have Docker installed. Then, you can run the following commands :

$ git clone 'https://github.com/NathanPERIER/nagato-manga'
$ cd nagato-manga/api
$ docker build .

Manual deployment

If you want to deploy the API without Docker, you will need python >= 3.6 and pip3 to be installed.

$ git clone 'https://github.com/NathanPERIER/nagato-manga'
$ cd nagato-manga/api
$ pip3 install -r requirements.txt # Only the first time or if missing dependencies after a pull
$ mkdir config
$ cp default-config/*.json config  # You should probably at least change the `chapters.destination` in `config/conf.json`
$ gunicorn --config default-config/gunicorn.conf.py nagato-api:app