update docs
This commit is contained in:
parent
abd01492db
commit
9b9834e163
3 changed files with 15 additions and 11 deletions
10
README.md
10
README.md
|
@ -1,4 +1,5 @@
|
|||
# SimpleLink
|
||||
|
||||
A very performant and light (6mb in memory) link shortener and tracker. Written in Rust and React and uses Postgres.
|
||||
|
||||

|
||||
|
@ -8,6 +9,7 @@ A very performant and light (6mb in memory) link shortener and tracker. Written
|
|||
## Build
|
||||
|
||||
### From Source
|
||||
|
||||
First configure .env.example and save it to .env
|
||||
|
||||
If DATABASE_URL is set, it will connect to a Postgres DB. If blank, it will use an sqlite db in /data
|
||||
|
@ -15,21 +17,24 @@ If DATABASE_URL is set, it will connect to a Postgres DB. If blank, it will use
|
|||
```bash
|
||||
#set api-domain to where you will be deploying the link shortener, eg: link.example.com, default is localhost:8080
|
||||
git clone https://github.com/waveringana/simplelink && cd simplelink
|
||||
./build.sh api-domain=localhost:8080
|
||||
./build.sh
|
||||
cargo run
|
||||
```
|
||||
|
||||
On an empty database, an admin-setup-token.txt is created as well as pasted into the terminal output. This is needed to make the admin account.
|
||||
|
||||
Alternatively if you want a binary form
|
||||
|
||||
```bash
|
||||
./build.sh --binary
|
||||
```
|
||||
|
||||
then check /target/release for the binary named `SimpleGit`
|
||||
|
||||
### From Docker
|
||||
|
||||
```bash
|
||||
docker build --build-arg API_URL=http://localhost:8080 -t simplelink .
|
||||
docker build --build-arg -t simplelink .
|
||||
docker run -p 8080:8080 \
|
||||
-e JWT_SECRET=change-me-in-production \
|
||||
-v simplelink_data:/data \
|
||||
|
@ -37,4 +42,5 @@ docker run -p 8080:8080 \
|
|||
```
|
||||
|
||||
### From Docker Compose
|
||||
|
||||
Adjust the included docker-compose.yml to your liking; it includes a postgres config as well.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue