Skip to content

Commit 5394ad5

Browse files
committed
Documentation fixes
1 parent 6fc2b32 commit 5394ad5

File tree

1 file changed

+11
-14
lines changed

1 file changed

+11
-14
lines changed

README.md

Lines changed: 11 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -47,26 +47,17 @@ Download the most suitable build for your system from the `releases`. This will
4747

4848
```Shell
4949
sudo mkdir -p /var/www/ip-location-api
50-
sudo wget -q -O /var/www/ip-location-api/ip-location-api https://github.com/paul-norman/ip-location-api/releases/download/1.0.0/ip-location-api-linux-x64.bin
50+
sudo wget -q -O /var/www/ip-location-api/ip-location-api https://github.com/paul-norman/ip-location-api/releases/download/v1.0.0/ip-location-api-linux-x64.bin
5151
sudo chmod +x /var/www/ip-location-api/ip-location-api
5252
```
5353

54-
Either make this folder writable for the user that will run the system, or create a downloads folder and make that writable:
55-
56-
```Shell
57-
sudo mkdir /var/www/ip-location-api/downloads
58-
sudo chmod 0777 /var/www/ip-location-api/downloads
59-
```
60-
61-
The system will download updates into this folder and process them.
62-
63-
Create a `.env` file in the main directory containing your required settings *(see next section)*:
54+
Create a `.env` file in the main directory containing your required settings *(see [Configuration](#configuration))*:
6455

6556
```Shell
6657
sudo nano /var/www/ip-location-api/.env
6758
```
6859

69-
Start the system and wait for it to update:
60+
Start the system and wait for it to update *(or create a [service](#install-as-a-service))*:
7061

7162
```Shell
7263
cd /var/www/ip-location-api
@@ -179,7 +170,7 @@ sudo nano /etc/systemd/system/ip-location-api.service
179170

180171
```
181172
[Unit]
182-
Description=Vikunja
173+
Description=IP-Location-API
183174
After=syslog.target
184175
After=network.target
185176
# Depending on how you configured the system, you may want to uncomment these:
@@ -201,6 +192,7 @@ WantedBy=multi-user.target
201192

202193
```Shell
203194
sudo systemctl enable ip-location-api
195+
sudo systemctl start ip-location-api
204196
```
205197

206198
## Updates
@@ -217,7 +209,7 @@ Any reverse proxy can handle this task, but for [Nginx](https://nginx.org/en/) t
217209
server {
218210
listen 443 ssl http2;
219211
listen [::]:443 ssl http2;
220-
server_name location-api.yoursite.com;
212+
server_name ip-location-api.yoursite.com;
221213
222214
include ssl.d/yoursite.com.conf;
223215
@@ -235,6 +227,11 @@ server {
235227
}
236228
```
237229

230+
```Shell
231+
sudo nginx -t
232+
sudo systemctl reload nginx
233+
```
234+
238235
## Benchmarks
239236

240237
These are very unscientific benchmarks running on my home PC. They use the built-in benchmarking route to test with. They are only meant to provide an idea of relative performance.

0 commit comments

Comments
 (0)