update readme
This commit is contained in:
parent
b221dfdeb7
commit
d1202a03fa
1 changed files with 19 additions and 0 deletions
19
README.md
19
README.md
|
@ -6,6 +6,25 @@ A very performant and light (6mb in memory) link shortener and tracker. Written
|
|||
|
||||

|
||||
|
||||
## How to Run
|
||||
|
||||
### From Docker:
|
||||
|
||||
```Bash
|
||||
docker run -p 8080:8080 \
|
||||
-e JWT_SECRET=change-me-in-production \
|
||||
-v simplelink_data:/data \
|
||||
simplelink
|
||||
```
|
||||
|
||||
Find the admin-setup-token pasted into the terminal output, or in admin-setup-token.txt in the container's root.
|
||||
|
||||
This is needed to register with the frontend. (TODO, register admin account with ENV)
|
||||
|
||||
### From Docker Compose:
|
||||
|
||||
Edit the docker-compose.yml file. It comes included with a postgressql db for use
|
||||
|
||||
## Build
|
||||
|
||||
### From Source
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue