diff --git a/Deployment.md b/Deployment.md index 1e1deed..9f90c11 100644 --- a/Deployment.md +++ b/Deployment.md @@ -1,25 +1,26 @@ The more hosted instances of AnonymousOverflow we have, the better load will be balanced between them all, leading to a better experience for everyone. -# Pre-requisites +
-* Server or an always-on computer -* Fast internet connection + +Alternative: Use the community pre-built Docker image + -# Dependencies - -AnonymousOverflow is deployed using Docker. Docker containerizes the app for a more convenient and secure deployment. - -## Install Docker - -If you don't have Docker already, follow the [official documentation](https://docs.docker.com/engine/install/) to install the engine. - -## Alternative: Use the pre-built Docker image +## Alternative: Use the community pre-built Docker image Follow the documentation here: https://codeberg.org/aryak/-/packages/container/anonymousoverflow-docker-builds/latest. ⚠️ This is an unofficial build and is not maintained by the maintainers of AnonymousOverflow. -## Clone the repo +
+ +
+ + +Alternative: Build the project yourself + + +## Alternative: Build the project yourself 1. Find a directory to put AnonymousOverflow's source code. 2. Clone the repo with `git clone https://github.com/httpjamesm/AnonymousOverflow`. @@ -37,6 +38,42 @@ AnonymousOverflow provides an example docker-compose file in `docker-compose.exa In the same directory as the `docker-compose.yml` file, run `docker compose up -d --build` to run the container in the background as a daemon (`-d`) and compile it (`--build`). +
+ +# Pre-requisites + +* Server or an always-on computer +* Fast internet connection + +# Dependencies + +AnonymousOverflow is deployed using Docker. Docker containerizes the app for a more convenient and secure deployment. + + + +## Install Docker + +If you don't have Docker already, follow the [official documentation](https://docs.docker.com/engine/install/) to install the engine. + +## Use the official pre-built Docker image + +1. Find a directory to put a configuration file. + +# Setup Compose + +AnonymousOverflow provides an example docker-compose file in `docker-compose.example.yml`. This defines the setup for the container. + +1. Copy it to `docker-compose.yml` using `cp docker-compose.example.yml docker-compose.yml`. +2. Modify ports if needed. + * Usually you want to edit the `ports:` section to meet your needs, especially if you're using a reverse proxy, like nginx. Try replacing the `- 80:8080` part with `- host:port:8080`. +3. Modify `environment:` to fit your setup. + +# Deploy + +In the same directory as the `docker-compose.yml` file, run `docker compose up -d` to pull the latest release and run the container in the background as a daemon (`-d`). + + + # Optional: Place a reverse proxy in front of it Reverse proxies are especially useful if you want to run multiple services on your machine. `nginx` is recommended.