2023-06-01 21:30:41 +00:00
|
|
|
<div align="center">
|
2023-06-01 21:32:04 +00:00
|
|
|
<img src="static/img/logo.png">
|
2023-06-01 21:31:10 +00:00
|
|
|
<h1>Indestructables</h1>
|
2023-06-01 21:32:42 +00:00
|
|
|
An open source alternative front-end to Instructables
|
2023-06-01 23:25:13 +00:00
|
|
|
|
2023-06-02 12:15:08 +00:00
|
|
|
<a href="https://indestructables.codeberg.page/">Website</a>
|
|
|
|
|
•
|
2023-06-02 12:11:59 +00:00
|
|
|
<a href="https://matrix.to/#/#indestructables-general:fedora.im">Matrix</a>
|
2023-06-01 21:30:41 +00:00
|
|
|
</div>
|
2023-06-01 21:25:13 +00:00
|
|
|
|
|
|
|
|
# Instances
|
|
|
|
|
None, yet!
|
|
|
|
|
|
|
|
|
|
# Run your own instance
|
2023-06-03 15:36:06 +00:00
|
|
|
|
|
|
|
|
## Step by step installation
|
|
|
|
|
|
|
|
|
|
### Dependencies
|
2023-06-03 13:50:44 +00:00
|
|
|
`pip3 install -r requirements.txt`.
|
|
|
|
|
|
|
|
|
|
For the production environment, you also need the uWSGI Python3 plugin. On Debian, it can be installed via `apt install uwsgi-plugin-python3`
|
2023-06-03 15:36:06 +00:00
|
|
|
### Production
|
2023-06-03 13:50:44 +00:00
|
|
|
1. Clone the repository
|
|
|
|
|
2. Run `uwsgi --plugin python3 --http-socket 0.0.0.0:8002 --wsgi-file main.py --callable app --processes 4 --threads 2`
|
|
|
|
|
3. Point your reverse proxy to http://localhost:8002
|
2023-06-03 15:36:06 +00:00
|
|
|
### Development
|
2023-06-03 13:50:44 +00:00
|
|
|
1. Clone the repository
|
|
|
|
|
2. Run `python3 main.py`
|
2023-06-03 15:36:06 +00:00
|
|
|
3. Connect to http://localhost:8002
|
|
|
|
|
|
|
|
|
|
## Docker installation
|
|
|
|
|
|
|
|
|
|
`docker build --tag indestructables .`
|
2023-06-03 15:39:59 +00:00
|
|
|
|
2023-06-03 15:36:06 +00:00
|
|
|
`docker run -d -p 5000:5000 indestructables`
|
