You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+33Lines changed: 33 additions & 0 deletions
Original file line number
Diff line number
Diff line change
@@ -110,6 +110,39 @@ Returns a specific client by his ID. The answer will be similar to the previous
110
110
111
111
Deletes a specific one client. If the client is not found, a 404 error will be returned.
112
112
113
+
## Development
114
+
115
+
### Requirements fo standalone app
116
+
117
+
1. wireguard + wireguard-tools
118
+
2. ruby 3.3.1
119
+
120
+
```bash
121
+
$ bundle install
122
+
```
123
+
124
+
Run app:
125
+
126
+
```bash
127
+
$ puma config.ru
128
+
```
129
+
130
+
### Run with docker
131
+
132
+
Build image:
133
+
134
+
```bash
135
+
$ docker build . -t wg-rest-api
136
+
```
137
+
138
+
Run app:
139
+
140
+
```bash
141
+
$ docker run -d -v /your_app_path:/app wg-rest-api
142
+
```
143
+
144
+
**pre-set the necessary environment variables in the .env file**
145
+
113
146
## Contribution
114
147
115
148
If you would like to contribute to the development, submit a pull request with your changes. We welcome any contributions that improve the service. You can also view the current project board here. You can also contribute by reporting bugs or suggesting new features. Please use the GitHub issues for that.
0 commit comments