Skip to content

Commit 1956b66

Browse files
mwfarbjuagargi
authored andcommitted
add list of webapp dependancies
1 parent 6694202 commit 1956b66

File tree

2 files changed

+91
-4
lines changed

2 files changed

+91
-4
lines changed

webapp/README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ Webapp is a Go application that will serve up a static web portal to make it eas
1010
## Packaged Setup/Run
1111
For running `webapp` in a package environment, like the default [SCIONLab](https://www.scionlab.org) environment, it will require command-line options for `webapp` to find the tools its requires. In most cases, the default `scionlab` and `scion-apps` packages will need to be specified on the command-line.
1212

13-
To run the Go Web UI at a specific address (-a) and port (-p) like 0.0.0.0:8000 for a SCIONLab VM use:
13+
To run the Go Web UI at a specific address `-a` and port `-p` like 0.0.0.0:8000 for a SCIONLab VM use:
1414
```shell
1515
webapp \
1616
-a 0.0.0.0 \
@@ -28,7 +28,7 @@ Now, open a web browser at [http://127.0.0.1:8000](http://127.0.0.1:8000), to be
2828

2929

3030
## Development Setup/Run
31-
For running `webapp` in a development environment for the SCION Infrastucture, follow the SCIONLab development install and run process at [https://github.com/netsec-ethz/netsec-scion](https://github.com/netsec-ethz/netsec-scion).
31+
For running `webapp` in a development environment for the SCION Infrastructure, follow the SCIONLab development install and run process at [https://github.com/netsec-ethz/netsec-scion](https://github.com/netsec-ethz/netsec-scion).
3232

3333
Then, follow these steps to install SCIONLab Apps to run `webapp` in development.
3434

@@ -62,13 +62,15 @@ webapp \
6262
-sgenc $GOPATH/src/github.com/scionproto/scion/gen-cache \
6363
-slogs $GOPATH/src/github.com/scionproto/scion/logs
6464
```
65-
or can run `webapp` with like this, which will use the defaults above:
65+
or can you run `webapp` like this, which will use the defaults above:
6666
```shell
6767
webapp
6868
```
6969

70+
## Dependancies
71+
A list of dependencies for `webapp` can be found at [dependencies.md](./dependencies.md).
7072

71-
## Command-Line Help
73+
## Help
7274
```shell
7375
Usage of webapp:
7476
-a string

webapp/dependencies.md

Lines changed: 85 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,85 @@
1+
# Webapp Dependencies
2+
3+
## Package Default CL
4+
```shell
5+
webapp \
6+
-a 0.0.0.0 \
7+
-p 8000 \
8+
-r /var/www/webapp/web/data \
9+
-srvroot /var/www/webapp/web \
10+
-sabin /usr/bin \
11+
-sroot /etc/scion \
12+
-sbin /usr/bin \
13+
-sgen /etc/scion/gen \
14+
-sgenc /var/lib/scion \
15+
-slogs /var/log/scion
16+
```
17+
18+
## Developer Default CL
19+
```shell
20+
webapp \
21+
-a 127.0.0.1 \
22+
-p 8000 \
23+
-r . \
24+
-srvroot $GOPATH/src/github.com/netsec-ethz/scion-apps/webapp/web \
25+
-sabin $GOPATH/bin \
26+
-sroot $GOPATH/src/github.com/scionproto/scion \
27+
-sbin $GOPATH/src/github.com/scionproto/scion/bin \
28+
-sgen $GOPATH/src/github.com/scionproto/scion/gen \
29+
-sgenc $GOPATH/src/github.com/scionproto/scion/gen-cache \
30+
-slogs $GOPATH/src/github.com/scionproto/scion/logs
31+
```
32+
33+
## System Binaries Used
34+
- bash
35+
- echo
36+
- cd
37+
- sed
38+
- date
39+
- curl
40+
- set
41+
- grep
42+
- python
43+
- df
44+
- tr
45+
- free
46+
- sleep
47+
- cat
48+
- systemctl
49+
50+
## SCION Binaries Used/Checked
51+
- $sbin/scmp
52+
- $sabin/bwtestclient
53+
- $sabin/imagefetcher
54+
- $sabin/sensorfetcher
55+
56+
## Scripts/Directories Used/Checked
57+
- $sroot/scion.sh (deprecated)
58+
- $slogs/bs[IA]-1.log
59+
- $sgen/ISD*/AS* (scanning for local IAs)
60+
- $sgen/ISD[ISD]/AS[AS]/endhost/topology.json
61+
- $sgenc/*.crt
62+
- $sgenc/*.trc
63+
- $sgenc/ps[IA]-1.path.db
64+
- /run/shm/dispatcher/default.sock
65+
- /run/shm/sciond/default.sock
66+
67+
## Static Webserver Required
68+
- $srvroot/favico.ico
69+
- $srvroot/config/
70+
- $srvroot/static/css/
71+
- $srvroot/static/html/
72+
- $srvroot/static/img/
73+
- $srvroot/static/js/
74+
- $srvroot/template/
75+
- $srvroot/tests/health/
76+
77+
## Static Webserver Generated
78+
- $srvroot/webapp.db
79+
- $srvroot/data/
80+
- $srvroot/data/images/
81+
- $srvroot/logs/
82+
83+
84+
85+

0 commit comments

Comments
 (0)