From fc008032d385733d3aeedab2d48c33f7782bd658 Mon Sep 17 00:00:00 2001
From: Kumi <git@kumi.email>
Date: Mon, 17 Jun 2024 19:10:38 +0200
Subject: [PATCH] docs: update README with Docker instructions and URL tweaks

Revised the URLs in the Instances section to be more concise by removing protocol prefixes. Added a new Production: Docker section to provide detailed instructions for running the application using Docker, enhancing deployment flexibility. Enhanced the Production section by renaming it to Production: Manual for clarity.

Addresses better readability and ease of use for setting up instances.
---
 README.md | 23 ++++++++++++++++++-----
 1 file changed, 18 insertions(+), 5 deletions(-)

diff --git a/README.md b/README.md
index bc1b01f..0ea1110 100644
--- a/README.md
+++ b/README.md
@@ -13,10 +13,10 @@ An open source alternative front-end to Instructables. This is a fork of <a href
 
 ## Instances
 
-| URL                                                                        | Provided by                               | Country | Comments |
-| -------------------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
-| [https://structables.private.coffee/](https://structables.private.coffee/) | [Private.coffee](https://private.coffee/) | Austria |          |
-| [https://structables.bloat.cat/](https://structables.bloat.cat/)           | [Bloat.cat](https://bloat.cat)            | Romania |          |
+| URL                                                               | Provided by                               | Country | Comments |
+| ----------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
+| [structables.private.coffee](https://structables.private.coffee/) | [Private.coffee](https://private.coffee/) | Austria |          |
+| [structables.bloat.cat](https://structables.bloat.cat/)           | [Bloat.cat](https://bloat.cat)            | Romania |          |
 
 To add your own instance to this list, please open a pull request or issue.
 
@@ -28,7 +28,7 @@ Of course, you can also join our [Matrix room](https://matrix.pcof.fi/#/#structa
 
 ## Run your own instance
 
-### Production
+### Production: Manual
 
 1. Create a virtual environment: `python3 -m venv venv`
 2. Activate the virtual environment: `source venv/bin/activate`
@@ -37,6 +37,19 @@ Of course, you can also join our [Matrix room](https://matrix.pcof.fi/#/#structa
 5. Point your reverse proxy to http://localhost:8002 and (optionally) serve static files from the `venv/lib/pythonX.XX/site-packages/structables/static` directory
 6. Connect to your instance under your domain
 
+### Production: Docker
+
+1. Copy `.env.example` to `.env` and adjust the settings as necessary
+2. Copy `docker-compose-example.yml` to `docker-compose.yml` and adjust it as necessary, for example modifying resource limits or changing the port/host configuration
+3. Build and run the Docker container:
+
+   ```sh
+   docker-compose up [-d]
+   ```
+
+4. Point your reverse proxy to http://127.0.0.1:8002 (or your chosen port, if you modified it) and (optionally) serve static files from the container's static directory
+5. Connect to your instance under your domain
+
 ### Development
 
 1. Clone the repository: `git clone https://git.private.coffee/privatecoffee/structables.git && cd structables`