Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Rework the toxchat/bootstrap-node Docker image. #1437

Merged
merged 1 commit into from
Apr 26, 2020
Merged

Rework the toxchat/bootstrap-node Docker image. #1437

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 4 additions & 5 deletions .travis.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ jobs:
- libvpx-dev # For toxav.
install: .travis/$JOB install
script: .travis/$JOB script
- stage: "Stage 1"
env: JOB=tox-bootstrapd-docker
services: [docker]
script: .travis/$JOB
- stage: "Stage 1"
if: type IN (push, api, cron)
env: JOB=cmake-win32
Expand All @@ -61,11 +65,6 @@ jobs:
os: osx
install: .travis/$JOB install
script: .travis/$JOB script
- stage: "Stage 1"
if: type IN (push, api, cron)
env: JOB=tox-bootstrapd-docker
services: [docker]
script: .travis/$JOB
- stage: "Stage 2"
if: type IN (push, api, cron)
env: JOB=cmake-freebsd
Expand Down
47 changes: 21 additions & 26 deletions .travis/tox-bootstrapd-docker
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,28 +2,23 @@

set -exu

# Copy source code to other/bootstrap_daemon/docker/c-toxcore
OLD_PWD=$PWD
cd /tmp
cp -a $OLD_PWD c-toxcore
mv c-toxcore $OLD_PWD/other/bootstrap_daemon/docker
cd $OLD_PWD
ls -lbh other/bootstrap_daemon/docker
ls -lbh other/bootstrap_daemon/docker/c-toxcore

cd other/bootstrap_daemon

# Make Docker container use our current source code instead of master branch
sed -i "s|WORKDIR /tmp/tox|WORKDIR /tmp/tox\nADD /c-toxcore ./c-toxcore/|g" docker/Dockerfile
sed -i 's|git clone|echo \\\#git clone|g' docker/Dockerfile
sed -i 's|git checkout|echo \\\#git checkout|g' docker/Dockerfile

cat docker/Dockerfile

sudo docker build -t tox-bootstrapd docker/
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
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
sudo docker run -d --name 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 tox-bootstrapd
docker run -d --name 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

sudo ls -lbh /var/lib/tox-bootstrapd

Expand All @@ -35,14 +30,14 @@ fi
COUNTER=0
COUNTER_END=120
while [ $COUNTER -lt $COUNTER_END ]; do
if sudo docker logs tox-bootstrapd | grep -q "Connected to another bootstrap node successfully" ; then
if docker logs tox-bootstrapd | grep -q "Connected to another bootstrap node successfully" ; then
break
fi
sleep 1
COUNTER=$(($COUNTER+1))
done

sudo docker logs tox-bootstrapd
docker logs tox-bootstrapd

if [ "$COUNTER" = "$COUNTER_END" ]; then
echo "Error: Didn't connect to any nodes"
Expand All @@ -52,9 +47,9 @@ fi
# Wait a bit befrore testing if the container is still running
sleep 30

sudo docker ps -a
docker ps -a

if [ "`sudo docker inspect -f {{.State.Running}} tox-bootstrapd`" != "true" ]; then
if [ "`docker inspect -f {{.State.Running}} tox-bootstrapd`" != "true" ]; then
echo "Error: Container is not running"
exit 1
fi
Expand All @@ -65,7 +60,7 @@ if ! cat /proc/$(pidof tox-bootstrapd)/limits | grep -P '^Max open files(\s+)327
exit 1
fi

if ! python3 ../fun/bootstrap_node_info.py ipv4 localhost 33445 ; then
if ! other/fun/bootstrap_node_info.py ipv4 localhost 33445 ; then
echo "Error: Unable to get bootstrap node info"
exit 1
fi
10 changes: 10 additions & 0 deletions cmake/ModulePackage.cmake
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,16 @@ if(NOT ENABLE_SHARED AND NOT ENABLE_STATIC)
set(ENABLE_SHARED ON)
endif()

option(FULLY_STATIC "Build fully static executables" OFF)
if(FULLY_STATIC)
set(CMAKE_EXE_LINKER_FLAGS "-static -no-pie")
# remove -Wl,-Bdynamic
set(CMAKE_EXE_LINK_DYNAMIC_C_FLAGS)
set(CMAKE_EXE_LINK_DYNAMIC_CXX_FLAGS)
set(ENABLE_SHARED OFF)
set(ENABLE_STATIC ON)
endif()

find_package(PkgConfig)

function(pkg_use_module mod pkg)
Expand Down
61 changes: 49 additions & 12 deletions other/bootstrap_daemon/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -216,22 +216,53 @@ sudo grep "tox-bootstrapd" /var/log/syslog

### Setting up

If you are familiar with Docker and would rather run the daemon in a Docker container, run the following from this directory:
If you are familiar with Docker and would rather run the daemon in a Docker container, you may download the latest official docker image. Check the GitHub [releases](https://github.com/TokTok/c-toxcore/releases) page for the latest version (e.g. v0.2.11), and run:

```sh
sudo docker build -t tox-bootstrapd docker/
docker pull toxchat/bootstrap-node:0.2.11
docker run --rm -it --entrypoint=sha256sum toxchat/bootstrap-node:latest /usr/local/bin/tox-bootstrapd
```

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
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:

```sh
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:

```sh
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

sudo docker run -d --name tox-bootstrapd --restart always -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 tox-bootstrapd
docker run -d --name tox-bootstrapd --restart always \
-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 kyepair 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:
```sh
sudo docker logs tox-bootstrapd
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.
Expand All @@ -243,26 +274,32 @@ You want to make sure that the daemon uses the newest toxcore, as there might ha
To update the daemon, all you need is to erase current container with its image:

```sh
sudo docker stop tox-bootstrapd
sudo docker rm tox-bootstrapd
sudo docker rmi tox-bootstrapd
docker stop tox-bootstrapd
docker rm tox-bootstrapd
docker rmi toxchat/bootstrap-node
```

Then rebuild and run the image again:

```sh
sudo docker build -t tox-bootstrapd docker/
sudo 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
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 \
-v /var/lib/tox-bootstrapd/:/var/lib/tox-bootstrapd/ \
-p 443:443 \
-p 3389:3389 \
-p 33445:33445 \
-p 33445:33445/udp \
toxchat/bootstrap-node
```

### Troubleshooting

- Check if the container is running:
```sh
sudo docker ps -a
docker ps -a
```

- Check the log for errors:
```sh
sudo docker logs tox-bootstrapd
docker logs tox-bootstrapd
```
127 changes: 72 additions & 55 deletions other/bootstrap_daemon/docker/Dockerfile
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,64 +1,81 @@
FROM debian:buster-slim
###########################################################
# Builder image: we compile the code here (static build)
FROM alpine:3.11.5 AS build

RUN ["apk", "--no-cache", "add",\
"build-base",\
"cmake",\
"linux-headers",\
"libconfig-dev",\
"libconfig-static",\
"libsodium-dev",\
"libsodium-static",\
"ninja",\
"python3"\
]

WORKDIR /src/c-toxcore

# Very selectively add files to the image, because we may have random stuff
# lying around. In particular, we don't need to rebuild the docker image when
# toxav changes or the Dockerfile changes down from the build.
COPY cmake cmake
COPY other/bootstrap_daemon/src other/bootstrap_daemon/src
COPY other/bootstrap_node_packets.[ch] other/
COPY other/DHT_bootstrap.c other/
COPY other/pkgconfig other/pkgconfig
COPY other/rpm other/rpm
COPY testing/misc_tools.[ch] testing/
COPY toxcore toxcore
COPY toxencryptsave toxencryptsave
COPY CMakeLists.txt so.version ./

RUN ["cmake", "-B_build", "-H.",\
"-GNinja",\
"-DCMAKE_BUILD_TYPE=Release",\
"-DFULLY_STATIC=ON",\
"-DBUILD_TOXAV=OFF",\
"-DBOOTSTRAP_DAEMON=ON"\
]
RUN ["cmake", "--build", "_build", "--target", "install"]

WORKDIR /tmp/tox
# Verify checksum from dev-built binary, so we can be sure Docker Hub doesn't
# mess with your binaries.
COPY other/bootstrap_daemon/docker/tox-bootstrapd.sha256 other/bootstrap_daemon/docker/
RUN ["sha256sum", "/usr/local/bin/tox-bootstrapd"]
RUN ["sha256sum", "-c", "other/bootstrap_daemon/docker/tox-bootstrapd.sha256"]

# Remove all the example bootstrap nodes from the config file.
COPY other/bootstrap_daemon/tox-bootstrapd.conf other/bootstrap_daemon/
# hadolint ignore=SC2086,SC2154
RUN ["sed", "-i", "/^bootstrap_nodes = /,$d", "other/bootstrap_daemon/tox-bootstrapd.conf"]

# Add bootstrap nodes from https://nodes.tox.chat/.
COPY other/bootstrap_daemon/docker/get-nodes.py other/bootstrap_daemon/docker/
RUN ["other/bootstrap_daemon/docker/get-nodes.py", "other/bootstrap_daemon/tox-bootstrapd.conf"]

###########################################################
# Final image build: this is what runs the bootstrap node
FROM debian:buster-slim

RUN export BUILD_PACKAGES="\
build-essential \
cmake \
git \
libconfig-dev \
libsodium-dev \
python3" && \
export RUNTIME_PACKAGES="\
libconfig9 \
libsodium23" && \
# get all deps
apt-get update && apt-get install -y $BUILD_PACKAGES $RUNTIME_PACKAGES && \
# install toxcore and daemon
git clone https://github.com/TokTok/c-toxcore && \
cd c-toxcore && \
# checkout latest release version
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') && \
mkdir _build && \
cd _build && \
cmake .. \
-DCMAKE_BUILD_TYPE=Release \
-DENABLE_SHARED=ON \
-DENABLE_STATIC=OFF \
-DBUILD_TOXAV=OFF \
-DBOOTSTRAP_DAEMON=ON && \
make -j`nproc` && \
make install -j`nproc` && \
cd .. && \
# add new user
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 && \
chmod 700 /var/lib/tox-bootstrapd && \
cp other/bootstrap_daemon/tox-bootstrapd.conf /etc/tox-bootstrapd.conf && \
# remove all the example bootstrap nodes from the config file
sed -i '/^bootstrap_nodes = /,$d' /etc/tox-bootstrapd.conf && \
# add bootstrap nodes from https://nodes.tox.chat/
python3 other/bootstrap_daemon/docker/get-nodes.py >> /etc/tox-bootstrapd.conf && \
# perform cleanup
apt-get remove --purge -y $BUILD_PACKAGES && \
apt-get clean && \
apt-get autoremove -y && \
rm -rf /var/lib/apt/lists/* && \
cd / && \
rm -rf /tmp/*
COPY --from=build /usr/local/bin/tox-bootstrapd /usr/local/bin/
COPY --from=build /src/c-toxcore/other/bootstrap_daemon/tox-bootstrapd.conf /etc/tox-bootstrapd.conf
RUN ["useradd", "--home-dir", "/var/lib/tox-bootstrapd", "--create-home",\
"--system", "--shell", "/sbin/nologin",\
"--comment", "Account to run the Tox DHT bootstrap daemon",\
"--user-group", "tox-bootstrapd"\
]
RUN ["chmod", "644", "/etc/tox-bootstrapd.conf"]
RUN ["chmod", "700", "/var/lib/tox-bootstrapd"]

WORKDIR /var/lib/tox-bootstrapd

USER tox-bootstrapd

ENTRYPOINT /usr/local/bin/tox-bootstrapd \
--config /etc/tox-bootstrapd.conf \
--log-backend stdout \
--foreground
ENTRYPOINT ["/usr/local/bin/tox-bootstrapd",\
"--config", "/etc/tox-bootstrapd.conf",\
"--log-backend", "stdout",\
"--foreground"\
]

EXPOSE 443/tcp 3389/tcp 33445/tcp 33445/udp
Loading