Skip to main content

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.

Support Private.coffee! Matrix PyPI PyPI - Python Version PyPI - License Latest Git Commit

Instances

URL Provided by Country Notes
structables.private.coffee Private.coffee Austria 🇦🇹 🇪🇺 Main instance
structables.bloat.cat Bloat.cat Germany 🇩🇪 🇪🇺
structables.darkness.services Darkness.services United States 🇺🇸

Tor Hidden Services

URL Provided by Country Notes
structables.coffee2m3bjsrrqqycx6ghkxrnejl2q6nl7pjw2j4clchjj6uk5zozad.onion Private.coffee Austria 🇦🇹 🇪🇺 Main instance
structables.darknessrdor43qkl2ngwitj72zdavfz2cead4t5ed72bybgauww5lyd.onion Darkness.services United States 🇺🇸

Adding Your Instance

To add your own instance to this list, please open a pull request or issue, see below.

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

  1. Create a virtual environment: python3 -m venv venv
  2. Activate the virtual environment: source venv/bin/activate
  3. Install the packages: pip install structables uwsgi
  4. Run uwsgi --plugin python3 --http-socket 0.0.0.0:8002 --module structables.main:app --processes 4 --threads 4
  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
  7. Ensure that /cron/ is executed at regular intervals so that the app updates its cached data.

Production: Docker

Note: The Docker image is now hosted on git.private.coffee instead of Docker Hub. Please use the new image name git.private.coffee/privatecoffee/structables instead of privatecoffee/structables to continue receiving updates.

  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:

    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 structables/static

  5. Connect to your instance under your domain

  6. Ensure that /cron/ is executed at regular intervals so that the app updates its cached data.

Development

  1. Clone the repository: git clone https://git.private.coffee/privatecoffee/structables.git && cd structables
  2. Create a virtual environment: python3 -m venv venv
  3. Activate the virtual environment: source venv/bin/activate
  4. Install in editable mode: pip install -e .
  5. Run structables
  6. Connect to http://localhost:8002

Environment Variables

Structables supports the use of the following environment variables for configuration:

  • STRUCTABLES_PORT: The port to listen on (default: 8002)
  • STRUCTABLES_LISTEN_HOST: The host/IP address to listen on (default: 127.0.0.1)
  • STRUCTABLES_INVIDIOUS: The hostname of an Invidious instance to use for embedded YouTube videos (currently not recommended due to YouTube blocks)
  • STRUCTABLES_UNSAFE: If set, allow embedding untrusted iframes (if unset, display a warning and allow loading the content manually)
  • STRUCTABLES_PRIVACY_FILE: The path to a text file or Markdown file (with .md suffix) to use for the Privacy Policy page (if unset, try privacy.txt or privacy.md in the working directory, or fall back to a generic message)
  • STRUCTABLES_DEBUG: If set, log additional debug information to stdout
  • STRUCTABLES_THEME: Allows selecting a theme for the frontend. Currently, only dark and light are supported. If not set, it will be automatically detected based on the user's system settings, and a toggle will be provided in the header.
  • STRUCTABLES_CACHE_ENABLED: Whether to enable caching of proxied content (default: true). Set to "false" or "0" to disable caching.
  • STRUCTABLES_CACHE_DIR: The directory to use for caching proxied content (default: structables_cache within the temporary directory as returned by tempfile.gettempdir())
  • STRUCTABLES_CACHE_MAX_AGE: The maximum age of cached content in seconds before it's considered stale (default: 604800 seconds, or 1 week)
  • STRUCTABLES_CACHE_MAX_SIZE: The maximum size of the cache directory in bytes (default: 1073741824 bytes, or 1GB)
  • STRUCTABLES_CACHE_CLEANUP_INTERVAL: How often to run the cache cleanup process in seconds (default: 3600 seconds, or 1 hour)

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.

Metadata

Release files for structables 0.4.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for structables 0.4.5
File Size Uploaded Provenance Actions
structables-0.4.5.tar.gz 987.0 kB Without provenance Details for structables-0.4.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for structables 0.4.5
File Interpreter ABI Platform Actions
structables-0.4.5-py3-none-any.whl Python 3 none any Details for structables-0.4.5-py3-none-any.whl

Total release size: 2.0 MB

Release files / structables-0.4.5.tar.gz

Download URL structables-0.4.5.tar.gz
Size 987.0 kB
Tags Source
SHA-256 checksum
How to use checksums
330a3bcdcc8e62ec1431bb06bf45d66db66b3143d520bc1aaa0a2c303142bedd
BLAKE2b-256 checksum
How to use checksums
f75348158a36cb46beb3bd4c016d3fe5ceb0e00297b616a3f9dfd2eef4fc3044
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.2

Release files / structables-0.4.5-py3-none-any.whl

Download URL structables-0.4.5-py3-none-any.whl
Size 993.7 kB
Tags Python 3
SHA-256 checksum
How to use checksums
e37532b72e75afd62c47c63a5163e2d950e8e80fda8e9ad04e9976c095cca815
BLAKE2b-256 checksum
How to use checksums
e8000cd933caaa55434b945fb975ddb88e7584a8d0cfae89686036fe642fdc40
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/7.0.0 CPython/3.11.2

Security for structables 0.4.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page