qmcgaw/updated repository overview

⁠Updated

Go program to update and push files periodically to a Git repository

⁠Features

• Periodically builds
  • A list of unique malicious hostnames
  • A list of unique malicious IP addresses
  • A list of unique ads hostnames
  • InterNIC's named roots for DNS resolvers
  • Root anchors XML for DNS resolvers
  • Root keys to be used by Unbound
• Optionally upload the changes to a Git repository using an SSH key
• Based on the Scratch image with a total uncompressed size of 15.4MB
• Compatible with amd64 only although it is easily cross CPU compiled if needed

⁠Setup

⁠Using Docker (recommended)

1. For bind mounting, create a files directory with the right permissions:

   mkdir files
   chown 1000 files
   chmod 700 files
   

   Copy

2. Use the following command:

   docker run -d -v $(pwd)/files:/files qmcgaw/updated
   

   Copy

   You can also use docker-compose.yml⁠ with:

   docker-compose up -d
   

   Copy

   To use with Git, you will also need to bind mount some files:

   • SSH key file at /key by default
   • SSH key passphrase optionally at /passphrase, if your SSH key is encrypted
   • SSH known hosts at /known_hosts by default, the default contains only Github key And set their ownership to user ID 1000 also.

3. Check logs with docker logs updated and update the image with docker pull qmcgaw/updated

⁠Environment variables

This Go program only reads parameters from environment variables for ease of use with Docker.

• Commonly used

  Environment variable	Default	Possible values	Description
  OUTPUT_DIR	./files	Any absolute or relative directory path	Directory where files are written to
  PERIOD	24h	Integer from 1	Period in minutes between each run
  RESOLVE_HOSTNAMES	no	yes or no	Resolve hostnames found to obtain IP addresses
  HTTP_TIMEOUT	3s	integer from 1	Default HTTP client timeout in milliseconds
  LOG_LEVEL	info	debug, info, warning, error	Logging level
  TZ	America/Montreal	string	Timezone

• Git operation

  Environment variable	Default	Possible values	Description
  GIT	no	yes or no	Do Git operations or not
  GIT_URL		SSH Git URL address	SSH URL to the remote repository, used only if GIT=yes
  SSH_KEY	./key	File path	File path containing your SSH key, only used if GIT=yes
  SSH_KEY_PASSPHRASE		File path	Optional file path containing your SSH key passphrase, only used if GIT=yes. Does not work with OpenSSH keys

• Checksums

  Environment variable	Default	Possible values	Description
  NAMED_ROOT_MD5	076cfeb40394314adf28b7be79e6ecb1	MD5 hexadecimal sum or ""	Named root MD5 sum. Disables checking if empty
  ROOT_ANCHORS_SHA256	45336725f9126db810a59896ae93819de743c416262f79c4444042c92e520770	SHA256 hexadecimal sum or ""	Root anchors SHA256 sum. Disables checking if empty

• Extras

  Environment variable	Default	Possible values	Description
  SHOUTRRR_SERVICES		One or more comma separated Shoutrrr URLs	Comma separated list of Shoutrrr URLs⁠

⁠Using Go

1. Build the program

   go build cmd/updated/main.go -o updated
   

   Copy

2. Depending on your system, change its permissions chmod +x updated

3. Run the program ./updated

⁠Why

This container is used to periodically update files at github.com/qdm12/files⁠ which are used by several other projects.

⁠TODOs

• Compress long repetitive files
• Unit tests (no time sorry)
• Version in json file with updated files
• Use lists from Blockada

⁠License

This repository is under an MIT license⁠