Kumi
98bc487d62
Clarified the instruction for serving static files by specifying the exact path `structables/static` instead of the container's static directory. This aims to reduce confusion and ensure accurate configuration. |
||
---|---|---|
.forgejo/workflows | ||
src/structables | ||
.env.example | ||
.gitignore | ||
cronjob.txt | ||
docker-compose-example.yml | ||
Dockerfile | ||
entrypoint.sh | ||
LICENSE | ||
pyproject.toml | ||
README.md |
Structables
An open source alternative front-end to Instructables. This is a fork of snowcatridge10's Indestructables, which itself is a fork of Cobra's Destructables.
Instances
URL | Provided by | Country | Comments |
---|---|---|---|
structables.private.coffee | Private.coffee | Austria | |
structables.bloat.cat | Bloat.cat | Romania |
To add your own instance to this list, please open a pull request or issue.
Opening Issues
If you're having problems using Structables, or if you have ideas or feedback for us, feel free to open an issue in the Private.coffee Git or on Github.
Of course, you can also join our Matrix room to discuss your ideas with us.
Run your own instance
Production: Manual
- Create a virtual environment:
python3 -m venv venv
- Activate the virtual environment:
source venv/bin/activate
- Install the packages:
pip install structables uwsgi
- Run
uwsgi --plugin python3 --http-socket 0.0.0.0:8002 --module structables.main:app --processes 4 --threads 4
- Point your reverse proxy to http://localhost:8002 and (optionally) serve static files from the
venv/lib/pythonX.XX/site-packages/structables/static
directory - Connect to your instance under your domain
Production: Docker
-
Copy
.env.example
to.env
and adjust the settings as necessary -
Copy
docker-compose-example.yml
todocker-compose.yml
and adjust it as necessary, for example modifying resource limits or changing the port/host configuration -
Build and run the Docker container:
docker-compose up [-d]
-
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
structables/static
-
Connect to your instance under your domain
Development
- Clone the repository:
git clone https://git.private.coffee/privatecoffee/structables.git && cd structables
- Create a virtual environment:
python3 -m venv venv
- Activate the virtual environment:
source venv/bin/activate
- Install in editable mode:
pip install -e .
- Run
structables
- Connect to http://localhost:8002
License
This project, as well as the two projects it is based on, are licensed under the GNU Affero General Public License v3. See the LICENSE file for more information.