tuxmain/rust-rpxy
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

docs: update docker docs

Browse source
This commit is contained in:
Jun Kurihara 2023-08-02 17:31:31 +09:00
commit 9645b2c321
6 changed files with 46 additions and 22 deletions
Download patch file Download diff file Expand all files Collapse all files

19
docker/README.md Normal file
View file

@ -0,0 +1,19 @@
# Docker Images of `rpxy`
The `rpxy` docker images are hosted both on [Docker Hub](https://hub.docker.com/r/jqtype/rpxy) and [GitHub Container Registry](https://github.com/junkurihara/rust-rpxy/pkgs/container/rust-rpxy). Differences among tags are summarized as follows.
## Latest Builds
- `latest`: Built from the `main` branch with default features, running on Ubuntu.
- `latest-slim`, `slim`: Built by `musl` from the `main` branch with default features, running on Alpine.
- `latest-s2n`, `s2n`: Built from the `main` branch with the `http3-s2n` feature, running on Ubuntu.
## Nightly Builds
- `nightly`: Built from the `develop` branch with default features, running on Ubuntu.
- `nightly-slim`: Built by `musl` from the `develop` branch with default features, running on Alpine.
- `nightly-s2n`: Built from the `develop` branch with the `http3-s2n` feature, running on Ubuntu.
## Caveats
Due to some compile errors of `s2n-quic` subpackages with `musl`, `nightly-s2n-slim` or `latest-s2n-slim` are not yet provided.

20
docker/docker-compose.slim.yml
View file

@ -1,7 +1,7 @@
version: "3"
services:
rpxy-rp:
image: jqtype/rpxy
image: jqtype/rpxy:slim # ghcr.io/junkurihara/rust-rpxy:slim also works
container_name: rpxy
init: true
restart: unless-stopped
@ -9,15 +9,15 @@ services:
- 127.0.0.1:8080:8080/tcp
- 127.0.0.1:8443:8443/udp
- 127.0.0.1:8443:8443/tcp
build:
context: ../
additional_contexts: # Uncomment when you build with musl
- messense/rust-musl-cross:amd64-musl=docker-image://messense/rust-musl-cross:x86_64-musl
- messense/rust-musl-cross:arm64-musl=docker-image://messense/rust-musl-cross:aarch64-musl
dockerfile: ./docker/Dockerfile.slim # based on alpine and build x86_64-unknown-linux-musl
platforms: # Choose your platforms
- "linux/amd64"
# - "linux/arm64"
# build: # Uncomment if you build yourself
# context: ../
# additional_contexts:
# - messense/rust-musl-cross:amd64-musl=docker-image://messense/rust-musl-cross:x86_64-musl
# - messense/rust-musl-cross:arm64-musl=docker-image://messense/rust-musl-cross:aarch64-musl
# dockerfile: ./docker/Dockerfile.slim # based on alpine and build x86_64-unknown-linux-musl
# platforms: # Choose your platforms
# - "linux/amd64"
# # - "linux/arm64"
environment:
- LOG_LEVEL=debug
- LOG_TO_FILE=true

20
docker/docker-compose.yml
View file

@ -1,7 +1,7 @@
version: "3"
services:
rpxy-rp:
image: jqtype/rpxy
image: jqtype/rpxy:latest # ghcr.io/junkurihara/rust-rpxy:latest also works
container_name: rpxy
init: true
restart: unless-stopped
@ -9,15 +9,15 @@ services:
- 127.0.0.1:8080:8080/tcp
- 127.0.0.1:8443:8443/udp
- 127.0.0.1:8443:8443/tcp
build:
context: ../
args: # Uncomment when build quic-s2n version
- "CARGO_FEATURES=--no-default-features --features http3-s2n"
- "ADDITIONAL_DEPS=pkg-config libssl-dev cmake libclang1 gcc g++"
dockerfile: ./docker/Dockerfile # based on ubuntu 22.04 and build x86_64-unknown-linux-gnu
platforms: # Choose your platforms
- "linux/amd64"
# - "linux/arm64"
# build: # Uncomment if you build yourself
# context: ../
# args: # Uncomment when build quic-s2n version
# - "CARGO_FEATURES=--no-default-features --features http3-s2n"
# - "ADDITIONAL_DEPS=pkg-config libssl-dev cmake libclang1 gcc g++"
# dockerfile: ./docker/Dockerfile # based on ubuntu 22.04 and build x86_64-unknown-linux-gnu
# platforms: # Choose your platforms
# - "linux/amd64"
# # - "linux/arm64"
environment:
- LOG_LEVEL=debug
- LOG_TO_FILE=true