summaryrefslogtreecommitdiff
path: root/other/bootstrap_daemon/README.md
diff options
context:
space:
mode:
authorMaxim Biro <nurupo.contributions@gmail.com>2017-04-12 08:07:06 -0400
committerMaxim Biro <nurupo.contributions@gmail.com>2017-04-19 20:22:28 -0400
commitf6285d7a60a75773f91754d5f254192139b5ceb8 (patch)
tree843701b69e8108b47968de52e2f36d695e3840ea /other/bootstrap_daemon/README.md
parent439f676d45d75f59f47a000a6adca8e9fe6a6e4e (diff)
Fix markdown formatting
Diffstat (limited to 'other/bootstrap_daemon/README.md')
-rw-r--r--other/bootstrap_daemon/README.md70
1 files changed, 30 insertions, 40 deletions
diff --git a/other/bootstrap_daemon/README.md b/other/bootstrap_daemon/README.md
index df7e72be..848f9fa1 100644
--- a/other/bootstrap_daemon/README.md
+++ b/other/bootstrap_daemon/README.md
@@ -1,29 +1,25 @@
1#Instructions 1# Instructions
2 2
3- [For `systemd` users](#systemd) 3- [For `systemd` users](#for-systemd-users)
4 - [Setting up](#systemd-setting-up) 4 - [Setting up](#setting-up)
5 - [Updating](#systemd-updating) 5 - [Updating](#updating)
6 - [Troubleshooting](#systemd-troubleshooting) 6 - [Troubleshooting](#troubleshooting)
7<br> 7- [For `SysVinit` users](#for-sysvinit-users)
8- [For `SysVinit` users](#sysvinit) 8 - [Setting up](#setting-up-1)
9 - [Setting up](#sysvinit-setting-up) 9 - [Updating](#updating-1)
10 - [Updating](#sysvinit-updating) 10 - [Troubleshooting](#troubleshooting-1)
11 - [Troubleshooting](#sysvinit-troubleshooting) 11- [For `Docker` users](#for-docker-users)
12<br> 12 - [Setting up](#setting-up-2)
13- [For `Docker` users](#docker) 13 - [Updating](#updating-2)
14 - [Setting up](#docker-setting-up) 14 - [Troubleshooting](#troubleshooting-2)
15 - [Updating](#docker-updating)
16 - [Troubleshooting](#docker-troubleshooting)
17 15
18 16
19These instructions are primarily tested on Debian Linux, Wheezy for SysVinit and Jessie for systemd, but they should work on other POSIX-compliant systems too. 17These instructions are primarily tested on Debian Linux, Wheezy for SysVinit and Jessie for systemd, but they should work on other POSIX-compliant systems too.
20 18
21 19
22<a name="systemd" /> 20## For `systemd` users
23##For `systemd` users
24 21
25<a name="systemd-setting-up" /> 22### Setting up
26###Setting up
27 23
28For security reasons we run the daemon under its own user. 24For security reasons we run the daemon under its own user.
29 25
@@ -68,8 +64,7 @@ Get your public key and check that the daemon initialized correctly:
68sudo grep "tox-bootstrapd" /var/log/syslog 64sudo grep "tox-bootstrapd" /var/log/syslog
69``` 65```
70 66
71<a name="systemd-updating" /> 67### Updating
72###Updating
73 68
74You want to make sure that the daemon uses the newest toxcore, as there might have been some changes done to the DHT, so it's advised to update the daemon at least once every month. 69You want to make sure that the daemon uses the newest toxcore, as there might have been some changes done to the DHT, so it's advised to update the daemon at least once every month.
75 70
@@ -91,8 +86,8 @@ sudo systemctl start tox-bootstrapd.service
91 86
92Note that `tox-bootstrapd.service` file might 87Note that `tox-bootstrapd.service` file might
93 88
94<a name="systemd-troubleshooting" /> 89
95###Troubleshooting 90### Troubleshooting
96 91
97- Check daemon's status: 92- Check daemon's status:
98```sh 93```sh
@@ -115,11 +110,11 @@ sudo journalctl -f _SYSTEMD_UNIT=tox-bootstrapd.service
115- Make sure tox-bootstrapd location matches its path in tox-bootstrapd.service file. 110- Make sure tox-bootstrapd location matches its path in tox-bootstrapd.service file.
116 111
117 112
118<a name="sysvinit" />
119##For `SysVinit` users
120 113
121<a name="sysvinit-setting-up" /> 114## For `SysVinit` users
122###Setting up 115
116
117### Setting up
123 118
124For security reasons we run the daemon under its own user. 119For security reasons we run the daemon under its own user.
125 120
@@ -170,8 +165,8 @@ Get your public key and check that the daemon initialized correctly:
170sudo grep "tox-bootstrapd" /var/log/syslog 165sudo grep "tox-bootstrapd" /var/log/syslog
171``` 166```
172 167
173<a name="sysvinit-updating" /> 168
174###Updating 169### Updating
175 170
176You want to make sure that the daemon uses the newest toxcore, as there might have been some changes done to the DHT, so it's advised to update the daemon at least once every month. 171You want to make sure that the daemon uses the newest toxcore, as there might have been some changes done to the DHT, so it's advised to update the daemon at least once every month.
177 172
@@ -191,8 +186,7 @@ After all of this is done, simply start the daemon back again:
191sudo service tox-bootstrapd start 186sudo service tox-bootstrapd start
192``` 187```
193 188
194<a name="sysvinit-troubleshooting" /> 189### Troubleshooting
195###Troubleshooting
196 190
197- Check daemon's status: 191- Check daemon's status:
198```sh 192```sh
@@ -213,11 +207,9 @@ sudo grep "tox-bootstrapd" /var/log/syslog
213- Make sure tox-bootstrapd location matches its path in the `/etc/init.d/tox-bootstrapd` init script. 207- Make sure tox-bootstrapd location matches its path in the `/etc/init.d/tox-bootstrapd` init script.
214 208
215 209
216<a name="docker" /> 210## For `Docker` users:
217##For `Docker` users:
218 211
219<a name="docker-setting-up" /> 212### Setting up
220###Setting up
221 213
222If you are familiar with Docker and would rather run the daemon in a Docker container, run the following from this directory: 214If you are familiar with Docker and would rather run the daemon in a Docker container, run the following from this directory:
223 215
@@ -239,8 +231,7 @@ sudo docker logs tox-bootstrapd
239 231
240Note that the Docker container runs a script which pulls a list of bootstrap nodes off https://nodes.tox.chat/ and adds them in the config file. 232Note that the Docker container runs a script which pulls a list of bootstrap nodes off https://nodes.tox.chat/ and adds them in the config file.
241 233
242<a name="docker-updating" /> 234### Updating
243###Updating
244 235
245You want to make sure that the daemon uses the newest toxcore, as there might have been some changes done to the DHT, so it's advised to update the daemon at least once every month. 236You want to make sure that the daemon uses the newest toxcore, as there might have been some changes done to the DHT, so it's advised to update the daemon at least once every month.
246 237
@@ -259,8 +250,7 @@ sudo docker build -t tox-bootstrapd docker/
259sudo docker run -d --name tox-bootstrapd --restart always -v /var/lib/tox-bootstrapd/:/var/lib/tox-bootstrapd/ -p 443:443 -p 3389:3389 -p 33445:33445 -p 33445:33445/udp tox-bootstrapd 250sudo docker run -d --name tox-bootstrapd --restart always -v /var/lib/tox-bootstrapd/:/var/lib/tox-bootstrapd/ -p 443:443 -p 3389:3389 -p 33445:33445 -p 33445:33445/udp tox-bootstrapd
260``` 251```
261 252
262<a name="docker-troubleshooting" /> 253### Troubleshooting
263###Troubleshooting
264 254
265- Check if the container is running: 255- Check if the container is running:
266```sh 256```sh