From bbce774d6cfbc0462750f55be3c844eaf2af8855 Mon Sep 17 00:00:00 2001 From: Pitu Date: Sat, 6 Feb 2021 00:25:43 +0900 Subject: chore: add docker docs --- README.md | 3 +++ docker/chibi.ps1 | 3 --- docker/chibi.sh | 2 -- docker/chibisafe.ps1 | 3 +++ docker/chibisafe.sh | 2 ++ docs/docker.md | 13 +++++++++++++ 6 files changed, 21 insertions(+), 5 deletions(-) delete mode 100644 docker/chibi.ps1 delete mode 100644 docker/chibi.sh create mode 100644 docker/chibisafe.ps1 create mode 100644 docker/chibisafe.sh create mode 100644 docs/docker.md 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/chibi.ps1 deleted file mode 100644 index d6494f3..0000000 --- a/docker/chibi.ps1 +++ /dev/null @@ -1,3 +0,0 @@ -$env = $args[0] -$cmd = $args | Select-Object -Skip 1 -docker-compose -f docker-compose.yml -f docker-compose.$env.yml -f docker-compose.config.yml $cmd diff --git a/docker/chibi.sh b/docker/chibi.sh deleted file mode 100644 index b6e2f44..0000000 --- a/docker/chibi.sh +++ /dev/null @@ -1,2 +0,0 @@ -#!/bin/bash -docker-compose -f docker-compose.yml -f docker-compose.$1.yml -f docker-compose.config.yml ${@%$1} diff --git a/docker/chibisafe.ps1 b/docker/chibisafe.ps1 new file mode 100644 index 0000000..d6494f3 --- /dev/null +++ b/docker/chibisafe.ps1 @@ -0,0 +1,3 @@ +$env = $args[0] +$cmd = $args | Select-Object -Skip 1 +docker-compose -f docker-compose.yml -f docker-compose.$env.yml -f docker-compose.config.yml $cmd diff --git a/docker/chibisafe.sh b/docker/chibisafe.sh new file mode 100644 index 0000000..b6e2f44 --- /dev/null +++ b/docker/chibisafe.sh @@ -0,0 +1,2 @@ +#!/bin/bash +docker-compose -f docker-compose.yml -f docker-compose.$1.yml -f docker-compose.config.yml ${@%$1} 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. -- cgit v1.2.3