chore: add docker docs

This commit is contained in:
Pitu 2021-02-06 00:25:43 +09:00
parent 58e900b5ac
commit bbce774d6c
4 changed files with 16 additions and 0 deletions

View File

@ -23,6 +23,9 @@ Chibisafe is a file uploader service written in node that aims to to be easy to
- Albums, tags and Discord-like search function
- User list and control panel
### Docker
To avoid all of this and use docker [read the docs here](docs/docker.md)
### Pre-requisites
This guide asumes a lot of things, including that you know your way around linux, nginx and internet in general.

13
docs/docker.md Normal file
View File

@ -0,0 +1,13 @@
### 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.
First make sure you have docker and docker composer installed, on Linux this would be `sudo apt install docker-ce`.
After that edit the config file called `docker-compose.config.example.yml` with the values you want. Those that are left commented will use the default values.
Once you are done editing that file remove the `example` from the name so it ends up being `docker-compose.config.yml` and run the following commands:
- `cd docker`
- `./chibisafe prod pull`
- `./chibisafe prod build`
- `./chibisafe prod up -d`
Congrats, your chibisafe instance is now running.