diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/docker.md | 14 | ||||
| -rw-r--r-- | docs/systemd.md | 8 |
2 files changed, 12 insertions, 10 deletions
diff --git a/docs/docker.md b/docs/docker.md index cdfa590..6354139 100644 --- a/docs/docker.md +++ b/docs/docker.md @@ -1,23 +1,23 @@ ### Using Docker -If you want to avoid all the hassle of installing the dependencies, configuring nginx and etc you can simply use our docker image which makes things way faster. +If you want to avoid all the hassle of installing the dependencies, configuring nginx and so on you can try our docker image which makes things a bit simpler. First make sure you have docker and docker composer installed, so please follow the install instructions for your OS/Distro: - https://docs.docker.com/engine/install/debian/ - https://docs.docker.com/compose/install/ After that: -- Copy the config file called `docker-compose.config.example.yml` to `docker-compose.config.yml` with the values you want. Those that are left commented will use the default values. -- Copy either `chibisafe.moe.http.example.conf` or `chibisafe.moe.https.example.conf` to `chibisafe.moe.conf` for either HTTP or HTTPS -- - If using HTTPS make sure to put your certs into the `ssl` folder and name them accordingly: +- Copy the config file called `docker-compose.config.example.yml` and name it `docker-compose.config.yml` with the values you want. Those that are left commented will use the default values. +- Copy either `chibisafe.moe.http.example.conf` or `chibisafe.moe.https.example.conf` and name it `chibisafe.moe.conf` for either HTTP or HTTPS +- - If using HTTPS make sure to put your certificates into the `ssl` folder and name them accordingly: - - - `chibisafe.moe.crt` for the certificate - - - `chibisafe.moe.key` for the certificate key Once you are done run the following commands: - `cd docker` -- `./chibisafe.sh prod pull` -- `./chibisafe.sh prod build` -- `./chibisafe.sh prod up -d` +- `./chibisafe prod pull` +- `./chibisafe prod build` +- `./chibisafe prod up -d` Congrats, your chibisafe instance is now running. diff --git a/docs/systemd.md b/docs/systemd.md index 8804573..7fe0004 100644 --- a/docs/systemd.md +++ b/docs/systemd.md @@ -1,5 +1,5 @@ ### Service config for systemd -The file chibisafe-example.service is to be moved to `/etc/systemd/system/chibisafe.service` +If you want to keep Chibisafe running by using systemd you can copy the example code shown below and create the file `/etc/systemd/system/chibisafe.service` with it. You will need to edit the parameters: - `User` to be the username/uid of your chibisafe instance @@ -12,7 +12,8 @@ You will need to edit the parameters: Example below. -```[Unit] +``` +[Unit] Description=chibisafe, easy to use file uploader After=network.target @@ -25,4 +26,5 @@ ExecStart=/usr/bin/npm run start Restart=always [Install] -WantedBy=multi-user.target``` +WantedBy=multi-user.target +``` |