PrivateCoffee/structables
4
0
Fork 1
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update README with Docker instructions and URL tweaks

Browse source 
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.
This commit is contained in:
Kumi 2024-06-17 19:10:38 +02:00
parent 0f91a929d2
commit fc008032d3
Signed by: kumi
GPG key ID: ECBCC9082395383F
1 changed files with 18 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -13,10 +13,10 @@ An open source alternative front-end to Instructables. This is a fork of <a href
## Instances ## Instances
| URL | Provided by | Country | Comments | | URL | Provided by | Country | Comments |
| -------------------------------------------------------------------------- | ----------------------------------------- | ------- | -------- | | ----------------------------------------------------------------- | ----------------------------------------- | ------- | -------- |
| [https://structables.private.coffee/](https://structables.private.coffee/) | [Private.coffee](https://private.coffee/) | Austria | | | [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 | | | [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. 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 ## Run your own instance
### Production ### Production: Manual
1. Create a virtual environment: `python3 -m venv venv` 1. Create a virtual environment: `python3 -m venv venv`
2. Activate the virtual environment: `source venv/bin/activate` 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 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 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 ### Development
1. Clone the repository: `git clone https://git.private.coffee/privatecoffee/structables.git && cd structables` 1. Clone the repository: `git clone https://git.private.coffee/privatecoffee/structables.git && cd structables`