Raoul Snyman
bcb29e3d1c
- Update hatch environments for linting, testing - Add initial Dockerfile - Add CI pipeline configuration - Add test - Add icon - Remove setup.py
34 lines
943 B
ReStructuredText
34 lines
943 B
ReStructuredText
===========
|
|
StickyNotes
|
|
===========
|
|
|
|
StickyNotes is a simple "pastebin" written in Python using Quart, SQLAlchemy, Pygments and a few other libraries.
|
|
|
|
Installation
|
|
------------
|
|
|
|
The easiest way to install StickyNotes is via Docker and Docker Compose. Here's an example config:
|
|
|
|
.. code-block:: yaml
|
|
|
|
version: '3'
|
|
services:
|
|
postgres:
|
|
image: postgres:15
|
|
env:
|
|
- POSTGRES_USER=stickynotes
|
|
- POSTGRES_DB=stickynotes
|
|
- POSTGRES_PASSWORD=stickynotes
|
|
restart: unless-stopped
|
|
volumes:
|
|
- "./data/postgres:/var/lib/postgresql/data"
|
|
app:
|
|
image: git.snyman.info/raoul/stickynotes:latest
|
|
env:
|
|
- SQLALCHEMY_URL=postgres://stickynotes:stickynotes@postgres/stickynotes
|
|
restart: unless-stopped
|
|
ports:
|
|
- "127.0.0.1:8000:8000"
|
|
|
|
Once you have that up and running, you can set up NGINX or another reverse proxy to port 8000 on 127.0.0.1.
|