Skip to content

Commit

Permalink
readme update
Browse files Browse the repository at this point in the history
  • Loading branch information
leonovk committed May 13, 2024
1 parent a471dc5 commit c00f7a0
Showing 1 changed file with 9 additions and 1 deletion.
10 changes: 9 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,9 +24,12 @@ curl -sSL https://get.docker.com | sh
sudo usermod -aG docker $(whoami)
exit
```

### 2. Build an image from a Dockerfile

clone this repository and build the image from the dockerfile

To automatically run simply run:
To run just run the command:

*Instead of 'wg-rest-api', substitute the name of the image that you specified during assembly*

Expand All @@ -38,9 +41,14 @@ To automatically run simply run:
-p 51820:51820/udp \
-p 3000:3000 \
--cap-add=NET_ADMIN \
--restart unless-stopped \
wg-rest-api
```

### Also important

By default, the application runs in single-threaded mode. This is not a solution for heavy loads. You can change this behavior by setting the appropriate environment variables "PUMA_THREADS" and "WORKERS". However, we do not recommend doing this. The application is not thread safe. If you need large loads, it is better to raise several application instances and set up load balancing between them.

## API

All requests are authorized using the bearer token that you specified in variable AUTH_TOKEN!
Expand Down

0 comments on commit c00f7a0

Please sign in to comment.