Skip to content

PythonistaGuild/MystBin

This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

a3936f2 · Jul 12, 2024
May 17, 2024
Jul 12, 2024
May 29, 2024
Jul 12, 2024
Jul 12, 2024
May 6, 2024
May 6, 2024
May 4, 2024
May 16, 2024
Nov 9, 2020
May 15, 2024
May 22, 2024
May 16, 2024
May 15, 2024
May 29, 2024
May 6, 2024
May 7, 2024
May 28, 2024
May 29, 2024

Repository files navigation

MystBin

Easily share code and text.

Website

API Documentation

Install on VSCode

Running without Docker

Requirements:

  • Postgres

Setup:

  • Clone
  • Copy config.template.toml into config.toml
  • For local testing [SERVER] > domain can be set to http://localhost:PORT (Default Port 8181)
  • Set Database connection DSN.
  • Optionally set URLs to a running Redis Instance.
  • ! If you haven't already: Create a Database in postgres (Default mystbin)
  • Install dependencies (Preferably to a venv): pip install -Ur requirements.txt
  • Optionally in core/server.py set ignore_localhost= to False in the RateLimit Middleware for testing.
  • Run: python launcher.py

Running with Docker

Requirements

  • Docker
  • Docker Compose

Setup:

  • Clone
  • Copy config.template.toml into config.toml
    • The default config for database (and redis) should work Out of Box.
  • Optionally in core/server.py set ignore_localhost= to False in the RateLimit Middleware for testing.
  • Run docker compose up -d to start the services.
    • If you want to use redis for session/limit handling, run with the redis profile: docker compose --profile redis up -d
    • The redis container doesn't expose connections outside of the network, but for added security edit redis.conf and change the password.