Skip to content

Add Docker image publishing, recommended installation and project history - #3052

Merged
madeye merged 2 commits into
masterfrom
docs/project-history
Sep 11, 2026
Merged

Add Docker image publishing, recommended installation and project history#3052
madeye merged 2 commits into
masterfrom
docs/project-history

Conversation

@madeye

@madeye madeye commented Sep 11, 2026

Copy link
Copy Markdown
Contributor

Make Docker the recommended server installation path and explain the repository's shadowsocks-libev history, modernization and rename to shadowsocks-c.

Add native AMD64/ARM64 image builds and GHCR publishing for ghcr.io/shadowsocks/shadowsocks-c. The scratch runtime uses static Clang/musl binaries, runs as an unprivileged user by default, and reads a mounted JSON configuration. PRs test without publishing; master/version pushes publish architecture images and assemble the multi-platform tag only after both tests pass.

Exercise actual read-only server/client containers with mounted configuration, hostname resolution, concurrent TCP streams up to 1 MiB, UDP payloads up to 4 KiB, AEAD and AEAD-2022, and clean shutdown. Update the README with TCP/UDP port mappings, configuration, version selection and a local-build fallback. Replace stale badges with current CI badges.

Validation: local ARM64 runtime build and container integration tests pass; image size is approximately 2.2 MB. All 35 local CTest cases, actionlint, Ruff and whitespace checks pass. All 24 build/test checks pass on 3f3f6bf, including native AMD64/ARM64 Docker runtime tests. The publish job is intentionally skipped for PRs.

Publication starts after merge. GHCR initially creates packages as private; an administrator must make the new package Public once before anonymous pulls work. This registry setup requirement and the local-build fallback are documented in docker/static/README.md.

@madeye madeye changed the title Document project history and the shadowsocks-c rename Add Docker image publishing, recommended installation and project history Sep 11, 2026
@madeye
madeye merged commit bff687b into master Sep 11, 2026
25 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant