diff --git a/README.md b/README.md index 3eb4090..1a68fe5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,41 @@ -# nextcloud-docker-compose -Build a Nextcloud instance in Docker Compose complete with MariaDB, Redis and SSL +# Nextcloud (Docker Compose) +Build a Nextcloud instance in Docker Compose complete with PostgreSQL, Redis and SSL + +# Prerequisites + +1. [Docker](https://docs.docker.com/engine/install/) +2. [Docker Compose](https://docs.docker.com/compose/install/) +3. SSL key and cert + +# Setup + +1. Create a copy of `.env.example`: + +```bash +cp .env.example .env +``` + +2. Replace the `SSL_CERT_PATH` and `SSL_KEY_PATH` variables in the newly created `.env` file to point to your SSL key and cert + +3. Replace the `NGINX_HOST` variable with your desired domain + +4. Replace `VOLUME_PATH` variable if you wish to change where volume data is stored + +5. Modify other variables as needed + +6. Create the required secrets files (you should consider restricting access to these files): + +```bash +# Postgres +echo "SuperSecretPassword" > secrets/postgres_password.txt # Replace with your own super secret password + +# Nextcloud +echo "admin" > secrets/nextcloud_admin_user.txt # Replace with desired admin username +echo "SuperSecretPassword" > secrets/nextcloud_admin_password.txt # Replace with super secret password for admin Nextcloud user +``` + +7. Bring up the containers! + +```bash +sudo docker-compose up --build -d +```