diff --git a/README.md b/README.md index 6de4213..6899026 100644 --- a/README.md +++ b/README.md @@ -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. diff --git a/docker/chibi.ps1 b/docker/chibisafe.ps1 similarity index 100% rename from docker/chibi.ps1 rename to docker/chibisafe.ps1 diff --git a/docker/chibi.sh b/docker/chibisafe.sh similarity index 100% rename from docker/chibi.sh rename to docker/chibisafe.sh diff --git a/docs/docker.md b/docs/docker.md new file mode 100644 index 0000000..f3fb23c --- /dev/null +++ b/docs/docker.md @@ -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.