12 lines
560 B
Markdown
12 lines
560 B
Markdown
# About the project
|
|
This simple shortlink server targets portable network devices and other low-performance machines.
|
|
|
|
It comes in form of AMD64 Docker Image, but you can use it on any other platform (tested natively on MacOS 26.0.1 Tahoe) and without Docker.
|
|
# Set up
|
|
Before launching the program:
|
|
|
|
- perform database migrations (in `./migrations` directory) manually or with your favourite tool;
|
|
- change Postgres password in `docker-compose.yml` and `.env`;
|
|
- change API_KEY to **LONG AND SECURE STRING** in `.env`.
|
|
|
|
# This code is licensed under Apache-2.0 |