@@ -11,23 +11,32 @@ To install this service, the fist time, you will need to:
11
11
1 . Required tools and versions:
12
12
1 . Install ` node ` and ` npm ` according to the directions at https://nodejs.org/en/download/package-manager
13
13
2 . Install ` pm2 ` using: ` npm install pm2 -g ` (as per https://www.npmjs.com/package/pm2#installing-pm2 )
14
+ 2 . Clone the service: ` https://github.com/Local-Connectivity-Lab/ccn-coverage-vis `
14
15
2 . Configure:
16
+ 1 . ` cd cd ccn-coverage-vis `
15
17
1 . Edit ` src/utils/config.ts ` and set the correct URL for your API host (if you're testing or you're deploying to a new URL).
16
- 3 . Deploy as below.
18
+ 4 . Deploy as below.
19
+ 5 . When starting the ccn-coverage-vis service the first time, use:
20
+ ```
21
+ pm2 start --name "Vis Server" npm -- run start
22
+ ```
23
+ This will register ccn-coverage-vis with [PM2](https://pm2.keymetrics.io/docs/usage/quick-start/).
17
24
18
25
19
26
## Deploying
20
27
Once the service has been setup (as above), it can be deployed using the following process:
21
28
1. Login to the coverage-host
22
29
2. Pull the lastest version from github
23
- 3 . Restart the server
30
+ 3. Restart the service
24
31
25
32
The shell commands are:
26
33
```
27
34
ssh coverage-host
28
35
cd ccn-coverage-vis
29
36
git pull
30
- pm2 restart
37
+ npm install
38
+ npm run build
39
+ pm2 restart Vis Server
31
40
```
32
41
33
42
## Troubleshooting & Recovery
@@ -47,10 +56,10 @@ If not, open up the browser **Web Developer Tools**, usually under the menu Tool
47
56
With this panel open at the bottom of the screen select the **Network** tab and refresh the browser page.
48
57
49
58
Look in the first column, Status:
50
- * 200: Ok
51
- * 502: Error with the backend services (behind nginx)
52
- * 500 errors: problem with nxginx. Look in ` /var/log/nginx/error.log ` for details.
53
- * 400 errors: problem with the service. Check the service logs and nginx logs.
59
+ * ` 200`: OK, everything is good.
60
+ * ` 502` : Error with the backend services (behind nginx)
61
+ * ` 500` errors: problem with nxginx. Look in `/var/log/nginx/error.log` for details.
62
+ * ` 400` errors: problem with the service. Check the service logs and nginx logs.
54
63
* Timeout or unreachable error: Something is broken in the network between your web browser and the coverage-vis host.
55
64
56
65
@@ -90,6 +99,12 @@ If you need to restart nginx, use:
90
99
sudo systemctl restart nginx
91
100
```
92
101
102
+ ### Clean Recovery
103
+ If nothing else works, the last option is a clean reinstall of the service. The process is:
104
+ * Remove the `ccn-coverage-vis` directory.
105
+ * Re-install as per **Initial Setup**.
106
+
107
+
93
108
## Testing
94
109
95
110
Changes to the main branch are automically built and deployed to: https://seattlecommunitynetwork.org/ccn-coverage-vis/
0 commit comments