Green Sky
aae086cc65
b03b571272 fix: flaky tcp test This only fixes the symptoms, not the real problem. Sometimes or consistently on some platforms a socket might need a moment before it can be written to. 32e67ab4c2 cleanup: use typedef for private message ID's in callback 7b1db6adc1 feat: add message IDs to private group messages 99e0bcc27d refactor: Observers/ignored peers can now send and receive custom packets b3c3c49d26 fix: Disable IPv6 in Windows cross-compilation tests e742deddff feat: Check hashes of Windows dependencies when cross-compiling dfb9a0b02b fix: Test the current Windows Dockerfile, not an old Dockerhub image 14de93ccec chore: Use WineHQ's Wine as Debian Bookworm's crashes ed37616249 docs: Update the Windows cross-compilation section 9bb79c174f cleanup: Remove a couple of unnecessary misc_tools dependencies 19475adb70 chore: Statically link OpenMP into the cracker fun util on Windows 1be311e51f feat: Build the fun utils when cross-compiling to Windows 88133f8446 chore: Strip Windows binaries 3cc0ae7535 refactor: Copy over all of the required static dependencies c4fa8f7fb1 feat: Generate .def, .exp and .lib files when building for Windows 74bbac5363 feat: Let CMake create the dll instead of doing so ourselves 246642e9ae feat: Harden Windows cross-compilation 8d431c0d11 chore: Bump Windows build dependency versions e519f7998b fix: Remove unnecessary wsock32 dependency on Windows ed2b60c217 chore: Use a specific non-broken slimcc version. d7f21010a1 chore: Update github actions. e71a68b7f2 docs: Update the list of CMake options 77e08876ff chore: Remove mod and founder from group API naming scheme 12bc042767 docs: add the experimental api build option to INSTALL.md e1fa5cae96 refactor: Rename Queries to Query to align with other enums. be82a3ea30 fix: Correct type for conference offline peer numbers. 0627c36716 test: Add pkgsrc build. 92578afe4b test: Add FreeBSD VM action on GitHub. 52ece0f57b test: Build toxcore on NetBSD (VM). 3fe8ee2c11 chore: Only install tox_private.h on request. 9a8dfa06ab fix: save_compatibility_test failing on big-endian systems 86f5e55578 fix: Don't serve files from websockify. 710eb674a5 fix: Correctly pass extended public keys to group moderation code. 021db7031c refactor: Use `struct`s for extended public/secret keys. a1e999fd80 chore: Compile libsodium reference implementation with compcert. fbe3c19cf5 cleanup: correct a few nullable annotations 623e3ee5c3 cleanup: Don't use `memcpy` to cast arbitrary `struct`s to `uint8_t[]`. c71567dc18 fix: Pass array, not array pointer, to `memcmp`. 9b46a08144 cleanup: Never pass `void*` directly to `memcpy`. 5d7b7a7bbc refactor: Use tox rng to seed the keypair generation. 961891d568 cleanup: Small improvements found by PVS Studio. 8201019f0d chore: Disable NGC saving by default, enable through Tox_Options. 5dd9ee3f65 cleanup: Replace pointer arithmetic with explicit `&arr[i]`. ca4606d49d refactor: Use strong typedef for NGC peer id. 442213b722 cleanup: Simplify custom packet length check in NGC. 08d3393def fix: Correct a few potential null derefs in bootstrap daemon. b9877b32b0 fix: Add missing memunlock of local variable when it goes out of scope. dab5fe44b9 fix: Zero out stack-allocated secret key before return. f058103299 refactor: Make prune_gc_sanctions_list more obviously correct. 3ba7a0dec9 docs: Add static analysis tool list to README. 8d0811a0f3 docs: Run prettier-markdown on markdown files. 969e3a2bfc refactor: Fix network test not using the strong typedef 93c83fbc7c refactor: Use strong typedef instead of struct for `Socket`. 9fe18b176f fix: Fix some false positive from PVS Studio. 7c44379ccb cleanup: Check that WINXP macro exists before comparing it. 5c93231bef refactor: Make tox mutex non-recursive. aacff73939 docs: Fix up doxyfile. d55fc85ff5 docs: Add more documentation to crypto_core. 5bdaaaedb6 refactor: Remove `Tox *` from `tox_dispatch`. e202341e76 refactor: Don't rely on tox_dispatch passing tox in tests. 34df938f52 chore: Use C++ mode for clang-tidy. 8b05296a78 chore: Check that both gtest and gmock exist for tests. 42010660e1 test: Add slimcc compiler compatibility test. b473630321 chore: Add some comments to the astyle config. b7404f24f6 cleanup: Remove implicit bool conversions. 4e2dba4d9f chore: Reformat sources with astyle. 4359e3a6bc chore: Rename C++ headers to .hh suffixes. 0c05566e58 cleanup: Further `#include` cleanups. 8d29935b7a chore: Only check the bootstrap daemon checksum on release. f70e588bc6 cleanup: Add more `const` where possible. 511bfe39c8 cleanup: Use Bazel modules to enforce proper `#include` hygiene. 1710a0d091 refactor: Move pack/unpack `IP_Port` from DHT into network module. a975943564 chore: Really fix coverage docker image build. c08409390f chore: Fix post-submit coverage image. 39aadf8922 fix: Don't use `memcmp` to compare `IP_Port`s. d94246a906 fix: partially fix a bug that prevented group part messages from sending. eeaa039222 chore: Fix rpm build; add a CI check for it. 8328449c1a chore: Speed up docker builds a bit by reducing layer count. d6d67d56f3 cleanup: Add `const` where possible in auto tests. 6aa9e6850d cleanup: Minor cleanup of event unpack code. bdf460a3a9 refactor: Rename `system_{memory,...}` to `os_{memory,...}`. 203e1af81e fix: a few off by one errors in group autotests 5c093c4888 cleanup: Remove all uses of `SIZEOF_VLA`. 662c2140f3 test: Add goblint static analyser. 8f07755834 cleanup: Use `memzero(x, s)` instead of `memset(x, 0, s)`. a7258e40cf cleanup: Use explicit 0 instead of `PACKET_ID_PADDING`. 6370d0f15d cleanup: Expand the `Tox_Options` accessor macros. 14a1a0b9bd cleanup: Remove plan9 support. a05dccad13 test: Add a simple new/delete test for Tox. 1cdcf938b9 cleanup: Add comment after every `#endif`. ba99d4dc4b test: Fix comment I broke in the events test PR. e07248debb refactor: Migrate auto_tests to new events API. bdd42b5452 refactor: Add common msgpack array packer with callback. 3c659f5288 cleanup: Rename group to conference in groupav documentation. 89957be230 cleanup: Ensure handler params are named after callback params. c650d9d345 refactor: Pass `this` pointer as first param to s11n callbacks. e7fb91ddb8 refactor: Allow NULL pointers for byte arrays in events. 5e2c8cabc1 cleanup: make some improvements to group moderation test 259de4867e cleanup: Remove `bin_pack_{new,free}`. 21a8ff5895 cleanup: skip a do_gc iteration before removing peers marked for deletion 16809dc36e feat: Add dht_get_nodes_response event to the events system. git-subtree-dir: external/toxcore/c-toxcore git-subtree-split: b03b5712720de9a9901ea12fd741f177327a7021 |
||
---|---|---|
.. | ||
bash-completion/completions | ||
docker | ||
src | ||
websocket | ||
BUILD.bazel | ||
CMakeLists.txt | ||
README.md | ||
tox-bootstrapd.conf | ||
tox-bootstrapd.service | ||
tox-bootstrapd.sh |
Instructions
These instructions are primarily tested on Debian Linux, Wheezy for SysVinit and Jessie for systemd, but they should work on other POSIX-compliant systems too.
For systemd
users
Setting up
For security reasons we run the daemon under its own user.
Create a new user by executing the following:
sudo useradd --home-dir /var/lib/tox-bootstrapd --create-home --system --shell /sbin/nologin --comment "Account to run Tox's DHT bootstrap daemon" --user-group tox-bootstrapd
Restrict access to home directory:
sudo chmod 700 /var/lib/tox-bootstrapd
Copy tox-bootstrapd.conf
file to where ExecStart=
from tox-bootstrapd.service
points to. By default it's /etc/tox-bootstrapd.conf
.
sudo cp tox-bootstrapd.conf /etc/tox-bootstrapd.conf
Go over everything in the copied tox-bootstrapd.conf
file. Set options you want and add actual working nodes to the bootstrap_nodes
list, instead of the example ones, if you want your node to connect to the Tox network. Make sure pid_file_path
matches PIDFile=
from tox-bootstrapd.service
.
Copy tox-bootstrapd.service
to /etc/systemd/system/
:
sudo cp tox-bootstrapd.service /etc/systemd/system/
You must uncomment the next line in tox-bootstrapd.service, if you want to use port number < 1024:
#CapabilityBoundingSet=CAP_NET_BIND_SERVICE
and, possibly, install libcap2-bin
or libcap2
package, depending of your distribution.
Reload systemd units definitions, enable service for automatic start (if needed), start it and verify it's running:
sudo systemctl daemon-reload
sudo systemctl enable tox-bootstrapd.service
sudo systemctl start tox-bootstrapd.service
sudo systemctl status tox-bootstrapd.service
Get your public key and check that the daemon initialized correctly:
sudo grep "tox-bootstrapd" /var/log/syslog
Updating
You 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.
To update the daemon first stop it:
sudo systemctl stop tox-bootstrapd.service
Then update your toxcore git repository, rebuild the toxcore and the daemon and make sure to install them.
Check if tox-bootstrapd.service
in toxcore git repository was modified since the last time you copied it, as you might need to update it too.
Reload tox-bootstrapd.service
if you have updated modified it:
sudo systemctl daemon-reload
After all of this is done, simply start the daemon back again:
sudo systemctl start tox-bootstrapd.service
Troubleshooting
- Check daemon's status:
sudo systemctl status tox-bootstrapd.service
- Check the log for errors:
sudo grep "tox-bootstrapd" /var/log/syslog
# or
sudo journalctl --pager-end
# or
sudo journalctl -f _SYSTEMD_UNIT=tox-bootstrapd.service
-
Make sure tox-bootstrapd user has write permission for keys and pid files.
-
Make sure tox-bootstrapd has read permission for the config file.
-
Make sure tox-bootstrapd location matches its path in tox-bootstrapd.service file.
For SysVinit
users
Setting up
For security reasons we run the daemon under its own user.
Create a new user by executing the following:
sudo useradd --home-dir /var/lib/tox-bootstrapd --create-home --system --shell /sbin/nologin --comment "Account to run Tox's DHT bootstrap daemon" --user-group tox-bootstrapd
Restrict access to home directory:
sudo chmod 700 /var/lib/tox-bootstrapd
Copy tox-bootstrapd.conf
file to where CFGFILE
variable from tox-bootstrapd.sh
points to. By default it's /etc/tox-bootstrapd.conf
.
sudo cp tox-bootstrapd.conf /etc/tox-bootstrapd.conf
Go over everything in the copied tox-bootstrapd.conf
file. Set options you want and add actual working nodes to the bootstrap_nodes
list, instead of the example ones, if you want your node to connect to the Tox network. Make sure pid_file_path
matches PIDFILE
from tox-bootstrapd.sh
.
Look at the variable declarations in the beginning of tox-bootstrapd.sh
init script to see if you need to change anything for it to work on your system. The default values must be fine for most users and we assume that you use those next.
If you have configured the daemon to use any port numbers that are lower than 1024, you need to execute the command below, as by default non-privileged users cannot open ports <1024. The change persists through reboot:
sudo setcap CAP_NET_BIND_SERVICE=+eip /usr/local/bin/tox-bootstrapd
Copy tox-bootstrapd.sh
init script to /etc/init.d/tox-bootstrapd
(note the disappearance of ".sh" ending):
sudo cp tox-bootstrapd.sh /etc/init.d/tox-bootstrapd
Set permissions for the init system to run the script:
sudo chmod 755 /etc/init.d/tox-bootstrapd
Make the init system aware of the script, start the daemon and verify it's running:
sudo update-rc.d tox-bootstrapd defaults
sudo service tox-bootstrapd start
sudo service tox-bootstrapd status
Get your public key and check that the daemon initialized correctly:
sudo grep "tox-bootstrapd" /var/log/syslog
Updating
You 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.
To update the daemon first stop it:
sudo service tox-bootstrapd stop
Then update your toxcore git repository, rebuild the toxcore and the daemon and make sure to install them.
Check if tox-bootstrapd.sh
in toxcore git repository was modified since the last time you copied it, as you might need to update it too.
After all of this is done, simply start the daemon back again:
sudo service tox-bootstrapd start
Troubleshooting
- Check daemon's status:
sudo service tox-bootstrapd status
- Check the log for errors:
sudo grep "tox-bootstrapd" /var/log/syslog
-
Check that variables in the beginning of
/etc/init.d/tox-bootstrapd
are valid. -
Make sure tox-bootstrapd user has write permission for keys and pid files.
-
Make sure tox-bootstrapd has read permission for the config file.
-
Make sure tox-bootstrapd location matches its path in the
/etc/init.d/tox-bootstrapd
init script.
For Docker
users:
Setting up
If you are familiar with Docker and would rather run the daemon in a Docker container, you may download the latest official docker image. To download the latest image run:
docker pull toxchat/bootstrap-node:latest
docker run --rm -it --entrypoint=sha256sum toxchat/bootstrap-node:latest /usr/local/bin/tox-bootstrapd
This will print the SHA256 checksum of the latest binary, which should agree with the SHA256 checksum in the Dockerfile.
If you want to build the bootstrap node from source, check out the latest release:
git checkout $(git tag --list | grep -P '^v(\d+).(\d+).(\d+)$' | \
sed 's/v/v /g' | sed 's/\./ /g' | \
sort -snk4,4 | sort -snk3,3 | sort -snk2,2 | tail -n 1 | \
sed 's/v /v/g' | sed 's/ /\./g')
and run the following from the top level c-toxcore directory:
tar c $(git ls-files) | docker build -f other/bootstrap_daemon/docker/Dockerfile -t toxchat/bootstrap-node -
sudo useradd \
--home-dir /var/lib/tox-bootstrapd \
--create-home \
--system \
--shell /sbin/nologin \
--comment "Account to run Tox's DHT bootstrap daemon" \
--user-group tox-bootstrapd
sudo chmod 700 /var/lib/tox-bootstrapd
docker run -d --name tox-bootstrapd --restart always \
--user "$(id -u tox-bootstrapd):$(id -g tox-bootstrapd)" \
-v /var/lib/tox-bootstrapd/:/var/lib/tox-bootstrapd/ \
--ulimit nofile=32768:32768 \
-p 443:443 \
-p 3389:3389 \
-p 33445:33445 \
-p 33445:33445/udp \
toxchat/bootstrap-node
We create a new user and protect its home directory in order to mount it in the Docker image, so that the keypair the daemon uses would be stored on the host system, which makes it less likely that you would loose the keypair while playing with or updating the Docker container.
You can check logs for your public key or any errors:
docker logs tox-bootstrapd
Note 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.
Updating
You 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.
To update the daemon, all you need is to erase current container with its image:
docker stop tox-bootstrapd
docker rm tox-bootstrapd
docker rmi toxchat/bootstrap-node
Then rebuild and run the image again:
tar c $(git ls-files) | docker build -f other/bootstrap_daemon/docker/Dockerfile -t toxchat/bootstrap-node -
docker run -d --name tox-bootstrapd --restart always \
--user "$(id -u tox-bootstrapd):$(id -g tox-bootstrapd)" \
-v /var/lib/tox-bootstrapd/:/var/lib/tox-bootstrapd/ \
--ulimit nofile=32768:32768 \
-p 443:443 \
-p 3389:3389 \
-p 33445:33445 \
-p 33445:33445/udp \
toxchat/bootstrap-node
Troubleshooting
- Check if the container is running:
docker ps -a
- Check the log for errors:
docker logs tox-bootstrapd