diff --git a/README.md b/README.md index 7dc75e5..fe1ae4b 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,36 @@ LibreCloud's website +## Docker Instructions + +1. **Fetch needed file(s)** + + Pick your preferred option to get the file(s) needed for Docker. Either option is fine, although Git is arguably the best option. + + **Option One:** Clone Git Repo + + ```bash + git clone https://git.pontusmail.org/librecloud/web.git + ``` + + **Option Two:** Download Compose file only + + ```bash + wget https://git.pontusmail.org/librecloud/web/raw/branch/main/docker-compose.yml + ``` + + You may have to install `wget`, or you could use `curl` instead. + +2. **Bring up the container** + + ```bash + docker compose up -d + ``` + + Please note: `sudo` may be required. + + You may customize the container with the included `docker-compose.yml` file if needed. Your server will start on port `3019` by default. We suggest using a reverse proxy to serve the site on a domain. + ## Dev Server Instructions 1. **Install Bun if you haven't already** diff --git a/docker-compose.yml b/docker-compose.yml index ca99fc8..07ee879 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,8 +1,8 @@ services: librecloud-web: - image: "git.pontusmail.org/LibreCloud/web:latest" + image: "git.pontusmail.org/librecloud/web:latest" ports: - - "3000:3000" + - "3019:3000" environment: - NODE_ENV=production restart: unless-stopped