Skip to content

Commit 4f4068c

Browse files
authored
Update README.md
1 parent ca57edc commit 4f4068c

File tree

1 file changed

+27
-14
lines changed

1 file changed

+27
-14
lines changed

README.md

+27-14
Original file line numberDiff line numberDiff line change
@@ -4,32 +4,45 @@ Web application that allows browsing and inspection of RPKI objects
44
## Install
55
There is a publicly available instance of MIRO running at http://rpki-browser.realmv6.org/
66

7-
If you wish to deploy MIRO yourself, download the latest release and follow these instruction:
7+
If you wish to deploy MIRO yourself, download the latest release (miro-x.x.tar.bz2) and follow these instruction:
88

99
### Web archive file
10-
The release contains the file 'miro.war'. This needs to be deployed with a servlet container such as [http://tomcat.apache.org/]tomcat.
10+
The release contains the file 'miro.war'. This needs to be deployed with a servlet container such as [tomcat](http://tomcat.apache.org/).
11+
12+
In case of tomcat:
13+
```
14+
tar -xzf apache-tomcat.tar.gz
15+
mv MIRO/miro.war apache-tomcat/webapps
16+
./apache-tomcat/bin/startup.sh
17+
```
18+
MIRO should show up at localhost:8080/miro/
1119

12-
In case of tomcat you can just drop the miro.war file into tomcat/webapps.
1320

1421
### Necessary directory structure
15-
In order for MIRO to work, you need to copy the directory "MIRO" found in the release archive to "/var/data".
16-
IMPORTANT: The user who is running the servlet container needs to have read/write access to /var/data/MIRO
22+
In order for MIRO to work, you need to copy the directory `MIRO` found in the release archive to `/var/data`.
23+
24+
**IMPORTANT: The user who is running the servlet container needs to have read/write access to `/var/data/MIRO`**
1725

1826
### Adding your own trust anchor locators
19-
The default directory for trust anchor locators is /var/data/MIRO/Browser/tals/
20-
The .tal files are grouped in sub-directories (RIPE, ARIN, APNIC, LACNIC, AFRINIC).
27+
The default directory for trust anchor locators is `/var/data/MIRO/Browser/tals/`.
28+
29+
The .tal files are grouped in sub-directories (`RIPE, ARIN, APNIC, LACNIC, AFRINIC`).
30+
31+
2132
If you wish to add your own trust anchor locators, make a new sub-directory and place your .tals in there:
2233
/var/data/MIRO/Browser/tals/<your-sub-directory>/<your-tal>.tal
2334

24-
Trust anchor locators are grouped by the repository the trust anchor resides is, so APNICs 5 trust anchors are all grouped together. This is done to make prefetching easier.
35+
Trust anchor locators should be grouped by _the repository the trust anchor resides in_. For example all 5 of APNICs trust anchors are grouped together. This is done to make prefetching easier.
2536

2637
#### Prefetching
27-
Some repositories have a flat structure, and thus the normal recursive fetching process takes a long time (using rsync). To shorten the process prefetching aims to download as much of the repository in advance. In MIRO/Browser/prefetching you can see the URIs set to being prefetched for every TAL grouping.
38+
Some repositories have a flat structure, and thus the normal recursive fetching process takes a long time (using rsync). To shorten the process prefetching aims to download as much of the repository in advance. In `MIRO/Browser/prefetching` you can see the URIs set to being prefetched for every TAL grouping.
39+
40+
If you are adding new TALs that point to repositories that are flat, it would be a good idea to make a file `/var/data/MIRO/Browser/prefetching/<your TAL group>` that contains URIs to prefetch.
2841

2942
### Updating
30-
In order to trigger an update, a connection coming from the loopback interface needs to be made to the update port (default 9234).
31-
One way to do this (python):
32-
```
43+
In order to trigger an update, a connection coming from the **loopback interface** needs to be made to the update port (default 9234).
44+
One way to do this (python2):
45+
```python
3346
sock = socket.socket()
3447
try:
3548
sock.connect(("localhost",9234))
@@ -40,10 +53,10 @@ except socket_error as e:
4053
To setup regular updates, use a cronjob.
4154

4255
### Export
43-
The last downloaded resource certificate trees as well as ROAs are saved at /var/data/MIRO/Browser/exports
56+
The last downloaded resource certificate trees as well as ROAs are saved at `/var/data/MIRO/Browser/exports`
4457

4558
### Config file
46-
In the conf file /var/data/MIRO/Browser/miro.browser.conf you can change the update port (default 9234)
59+
In the conf file `/var/data/MIRO/Browser/miro.browser.conf` you can change the update port (default 9234)
4760

4861

4962
##API

0 commit comments

Comments
 (0)