Files
Tom Chivert cae3105fa8
build / build (push) Successful in 1m0s
edit readme
2023-09-22 15:05:03 +02:00

31 lines
717 B
Markdown

# MiniShortener
Just a simple and light URL shortener.
## Deployment
Change user/pass and port if needed in the docker-compose.yml, create the database file, and then start the container :
```bash
git clone https://git.rznet.fr/razian/minishortener.git
cd minishortener
vim docker-compose.yml
touch urls.db
docker-compose up -d
```
## Usage
You can use some commands directly in the input bar :
- `admin` to get to the admin page
- Any link previously generated can be pasted as an input to show some stats
## Environment Variables
This project uses env vars to set the admin login :
- `USER` : default admin
- `PASS` : default admin/changeme
These are already set in the docker-compose file.