Skip to content

Commit 23cfa2e

Browse files
author
Paul Philion
committed
Outline of operational docs.
1 parent 48268f4 commit 23cfa2e

File tree

1 file changed

+63
-1
lines changed

1 file changed

+63
-1
lines changed

README.md

Lines changed: 63 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,69 @@ Visualizations of coverage and performance analysis for Community Cellular Netwo
44

55
Now hosted on https://coverage.seattlecommunitynetwork.org/
66

7-
# Testing & Deployment
7+
8+
## Initial Setup
9+
To install this service, the fist time, you will need to:
10+
11+
1. Required tools and versions:
12+
1. node
13+
2. npm
14+
2. Configure:
15+
1. x
16+
2. y
17+
3. z
18+
3. Deploy as below.
19+
20+
* What tools are needed and how are they installed?
21+
* What configuration is needed?
22+
* How is configuration set?
23+
24+
25+
## Deploying
26+
Once the service has been setup (as above), it can be deployed using the following process:
27+
1. Login to the <coverage-host>
28+
2. Pull the lastest version from github
29+
3. Restart the server
30+
31+
```
32+
ssh <coverage-host>
33+
cd ccn-coverage-vis
34+
git pull
35+
pm2 restart
36+
```
37+
38+
## Troubleshooting & Recovery
39+
When a problem occurs, there are several checks to determine where the failure is:
40+
1. Check HTTP errors in the browser
41+
1. Login to the <coverage-host>
42+
2. Confirm ccn-coverage-vis is operating as expected
43+
3. Confirm nginx is operating as expected
44+
45+
### Checking HTTP errors in the browser
46+
47+
48+
49+
### Checking ccn-coverage-vis with pm2
50+
51+
```
52+
ssh <coverage-host>
53+
pm2 list
54+
# expect "API" in the list, expect running, screenshot
55+
```
56+
57+
58+
Running? check pm2
59+
60+
61+
### Checking nginx
62+
63+
Check service operation
64+
65+
Check nginx logs
66+
67+
68+
69+
## Testing
870

971
Changes to the main branch are automically built and deployed to: https://seattlecommunitynetwork.org/ccn-coverage-vis/
1072

0 commit comments

Comments
 (0)