From 1c49dcd85624daee1977ed5f9452514988bfea14 Mon Sep 17 00:00:00 2001 From: Starbeamrainbowlabs Date: Sat, 3 Apr 2021 20:10:33 +0100 Subject: [PATCH] README: Add shiori, and expand FAQ --- README.md | 24 ++++++++++++++++++++---- 1 file changed, 20 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 79dedf3..2935493 100644 --- a/README.md +++ b/README.md @@ -27,13 +27,28 @@ Multiple reasons: 2. Bandwidth reduction / speed: basing them on my custom base image that proxies apt through a local [apt-cacher-ng](https://wiki.debian.org/AptCacherNg) instance 3. Security: I know precisely how the Dockerfile works and everything it depends on, because I've written it myself 4. Compatibility: - - I use [Hashicorp Nomad](https://www.nomadproject.io/), so some of these Dockerfiles are written explicitly with Hashicorp Nomad in mind. - - My Hashicorp Nomad cluster is comprised chiefly of Raspberry Pis (currently running armv7l, but an upgrade to arm64 is planned eventually), and many Docker containers on the Docker Hub are built by default for amd64 + - I use [Hashicorp Nomad](https://www.nomadproject.io/), so some of these Dockerfiles are written explicitly with Hashicorp Nomad in mind - e.g. the [`NOMAD_PORT_*` environment variables](https://www.nomadproject.io/docs/job-specification/network#port-parameters). + - My Hashicorp Nomad cluster is comprised chiefly of Raspberry Pis (currently running armv7l, but an upgrade to arm64 is planned eventually), and many Docker containers on the Docker Hub are built by default for amd64 5. Maintainability: I want to ensure I keep my Docker images up-to-date, so I rebuild them myself regularly via my [Continuous Integration server](https://laminar.ohwg.net/) ### Why do I need to run a private Docker registry for `imagebuilder.sh` to work? `imagebuild.sh` is designed to automatically build the specified Docker image and then push it to a private Docker registry because then the hosts in my Hashicorp Nomad +### These Dockerfiles don't work for me! +These Dockerfiles are specific to my environment. They depend on a patched version of `minideb` as a base image, which this package is also responsible for building. The key changes to `minideb` include: + +1. Config directive to tell `apt` to use my local apt-cacher-ng instance to save bandwidth / speed things up +2. Apt repository definition for [my personal apt repository](https://apt.starbeamrainbowlabs.com/). + +To set your own apt caching proxy address, do this before calling `imagebuilder.sh build minideb`: + +```bash +export proxy_address="http://example.com:3142"; +``` + +Note that an apt caching proxy is *required* for it to work. If you don't yet have one setup, I have a blog post about it here: [Cluster, Part 5: Staying current | Automating apt updates and using apt-cacher-ng](https://starbeamrainbowlabs.com/blog/article.php?article=posts/411-cluster-5-staying-current.html) + + ### I've found a security issue, how can I contact you? Please use the contact details on my website and _privately_ get in touch (don't leave a public comment on my blog): @@ -53,8 +68,8 @@ Image | Purpose `minideb-node` | `minideb` with the latest Node.js installed via our [apt repository](https://apt.starbeamrainbowlabs.com/) `node-serve` | `minideb-node` with [serve](https://www.npmjs.com/package/serve) installed & set as the entrypoint `paperless-ng` | Dockerised [paperless-ng](https://github.com/jonaswinkler/paperless-ng) - currently under construction -`redis` | Dockerised [redis](https://redis.io/) - +`redis` | Dockerised [redis](https://redis.io/), installs the latest stable version +`shiori` | Dockerised [shiori](https://github.com/go-shiori/shiori), built from source ## Docker container UID/GID map @@ -65,6 +80,7 @@ UID | GID | Container | Notes 70 | 70 | etherpad | 80 | 80 | serve | Static HTTP Server based on Node.js 90 | 90 | jellyfin | +95 | 95 | shiorio | Shiori bookmark system, built from source 999 | 994 | certbot | The same user & group as fabio, because file permissions 2100 | 2100 | redis |