2024-03-31 14:45:26 +09:00
# Krll
2024-05-05 19:33:38 +09:00
Krll, a privacy-friendly open source URL shortener
2024-03-31 14:45:26 +09:00
https://krll.me
2024-05-05 19:33:38 +09:00
## Run
1. Copy `.env.example` to `.env` and edit it
- NAME: Krll server's name(ex: Krll)
- HOST: Krll server's host(ex: https://krll.me)
- CONTACT: Server operator's contact info
- POSTGRES_...: PostgreSQL setting(If you'll run postgresql with docker compose, you should edit just 'POSTGRES_PASSWORD', if not, you should edit 'POSTGRES_HOST' to your postgresql's host.)
2. RUN
```bash
# with docker compose
cp docker-compose.example.yml docker-compose.yml
docker compose up -d
# without docker compose
2024-03-31 14:45:26 +09:00
python -m venv venv
source ./venv/bin/activate/
pip install -r requirements.txt
uvicorn main:app --reload
```