Skip to content
This repository has been archived by the owner on Jun 24, 2023. It is now read-only.

Commit

Permalink
docs: update readme (docker)
Browse files Browse the repository at this point in the history
  • Loading branch information
Fariz Rizaldy committed Feb 13, 2020
1 parent ac5f757 commit 0889dc2
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ track link distribution without tracking any personal data.

## Development

Make sure you have Go & SQLite installed, if not, you know what's next.
Make sure you have Go & SQLite installed (and it's dependencies), if not, you know what's next.

- Build the application: `make`
- Run the server: `GOW_TOKEN=<token> ./gow`
Expand All @@ -35,22 +35,27 @@ run `npm run dev` in `web` directory.
- `HOST` - Helpful when you are using reverse proxy, default: `localhost`
- `PORT` - Helpful in case you don't use container technology, default: `3030`

For now (v0.1.0), authorization is done in Layer 7 (Load Balancer), but I will fix this.
For now (v0.2.0), authorization is done in Layer 7 (Load Balancer), but I will fix this.

## Deployment

There are 2 way to run this program in Production

### Quick way

- Pull the image: `docker pull evilfactorylabs/gow:<version>`
- Run it: `docker run -d -e TOKEN="<token>" -v ~/data:/app/data evilfactorylabs/gow:<version>`

### As Binary

- Clone repo
- Build code: `make`
- Run program: `GOW_TOKEN=<token> ./gow`

### As Docker Container (TODO)
### As Docker Container

- Build image: `docker build -t . evilfactorylabs/gow:latest`
- Run image: `docker run -d evilfactorylabs/gow:latest`
- Run image: `docker run -d -e TOKEN="<token>" -v ~/data:/app/data evilfactorylabs/gow:<version>`

## Roadmap

Expand Down

0 comments on commit 0889dc2

Please sign in to comment.