a/badguardhome
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
44c7221ae9
badguardhome/scripts
History
Ainar Garipov abf8f65f05 Pull request: Remove Docker VOLUME instruction for more flexibility 
Merge in DNS/adguard-home from 2589-docker-volumes to master

Squashed commit of the following:

commit 5bff6ffa3138e9c09b786e4ff26fe286daa78c05
Merge: f0e9a74c e71019a1
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Mon Jan 25 14:45:15 2021 +0300

    Merge branch 'master' into 2589-docker-volumes

commit f0e9a74cc3d8baecaac68730b684e65ec3178886
Author: Ainar Garipov <A.Garipov@AdGuard.COM>
Date:   Mon Jan 25 14:44:07 2021 +0300

    all: doc changes

commit 76e538ca5f086fa99328dc10a05e7ca581457192
Author: Alex Povel <alex.povel@tuhh.de>
Date:   Thu Jan 21 15:07:11 2021 +0100

    Remove Docker VOLUME instruction for more flexibility

    Inheriting from the base image is made easier without
    the VOLUME instruction, since it cannot be reverted.
    All guides contain `--volume` explanations/usage
    examples anyway, so the VOLUME instructions in the
    Dockerfile aren't necessary.

    See also https://stackoverflow.com/a/62068396/11477374 for more
    examples for why that instruction can be harmful.
2021-01-25 18:07:49 +03:00
..
hooks Pull request: openapi: fix more docs issues 2021-01-14 13:48:52 +03:00
make Pull request: Remove Docker VOLUME instruction for more flexibility 2021-01-25 18:07:49 +03:00
querylog Pull request: all: add a new Makefile and scripts, remove goreleaaser 2020-12-30 18:26:25 +03:00
snap Pull request: all: add a new Makefile and scripts, remove goreleaaser 2020-12-30 18:26:25 +03:00
translations Pull request: all: add a new Makefile and scripts, remove goreleaaser 2020-12-30 18:26:25 +03:00
whotracksme Pull request: all: add a new Makefile and scripts, remove goreleaaser 2020-12-30 18:26:25 +03:00
install.sh Pull request: all: add a new Makefile and scripts, remove goreleaaser 2020-12-30 18:26:25 +03:00
README.md Pull request: all: add a new Makefile and scripts, remove goreleaaser 2020-12-30 18:26:25 +03:00

README.md

AdGuard Home Scripts

hooks/: Git Hooks

Usage

Run make init from the project root.

querylog/: Query Log Helpers

Usage

  • npm install: install dependencies. Run this first.
  • npm run anonymize <source> <dst>: read the query log from the <source> and write anonymized version to <dst>.

make/: Makefile Scripts

The release channels are: development (the default), edge, beta, and release. If verbosity levels aren't documented here, there are only two: 0, don't print anything, and 1, be verbose.

build-docker.sh: Build A Multi-Architecture Docker Image

Required environment:

  • CHANNEL: release channel, see above.
  • COMMIT: current Git revision.
  • DIST_DIR: the directory where a release has previously been built.
  • VERSION: release version.

Optional environment:

  • DOCKER_IMAGE_NAME: the name of the resulting Docker container. By default it's adguardhome-dev.
  • DOCKER_OUTPUT: the --output parameters. By default they are type=image,name=${DOCKER_IMAGE_NAME},push=false.
  • SUDO: allow users to use sudo or doas with docker. By default none is used.

build-release.sh: Build A Release For All Platforms

Required environment:

  • CHANNEL: release channel, see above.
  • GPG_KEY and GPG_KEY_PASSPHRASE: data for gpg. Only required if SIGN is 1.

Optional environment:

  • DIST_DIR: the directory to build a release into. The default value is dist.
  • GO: set an alternarive name for the Go compiler.
  • SIGN: 0 to not sign the resulting packages, 1 to sign. The default value is 1.
  • VERBOSE: 1 to be verbose, 2 to also print environment. This script calls go-build.sh with the verbosity level one level lower, so to get verbosity level 2 in go-build.sh, set this to 3 when calling build-release.sh.
  • VERSION: release version. Will be set by version.sh if it is unset or it has the default Makefile value of v0.0.0.

clean.sh: Cleanup

Optional environment:

  • GO: set an alternarive name for the Go compiler.

Required environment:

  • DIST_DIR: the directory where a release has previously been built.

go-build.sh: Build The Backend

Optional environment:

  • GOARM: ARM processor options for the Go compiler.
  • GOMIPS: ARM processor options for the Go compiler.
  • GO: set an alternarive name for the Go compiler.
  • OUT: output binary name.
  • PARALLELISM: set the maximum number of concurrently run build commands (that is, compiler, linker, etc.).
  • VERBOSE: verbosity level. 1 shows every command that is run and every Go package that is processed. 2 also shows subcommands and environment. The default value is 0, don't be verbose.

Required environment:

  • CHANNEL: release channel, see above.
  • VERSION: release version.

go-deps.sh: Install Backend Dependencies

Optional environment:

  • GO: set an alternarive name for the Go compiler.
  • VERBOSE: verbosity level. 1 shows every command that is run and every Go package that is processed. 2 also shows subcommands and environment. The default value is 0, don't be verbose.

go-lint.sh: Run Backend Static Analyzers

Don't forget to run make go-tools once first!

Optional environment:

  • EXIT_ON_ERROR: if set to 0, don't exit the script after the first encountered error. The default value is 1.
  • GO: set an alternarive name for the Go compiler.
  • VERBOSE: verbosity level. 1 shows every command that is run. 2 also shows subcommands. The default value is 0, don't be verbose.

go-test.sh: Run Backend Tests

Optional environment:

  • GO: set an alternarive name for the Go compiler.
  • RACE: set to 0 to not use the Go race detector. The default value is 1, use the race detector.
  • VERBOSE: verbosity level. 1 shows every command that is run and every Go package that is processed. 2 also shows subcommands. The default value is 0, don't be verbose.

go-tools.sh: Install Backend Tooling

Installs the Go static analysis and other tools into ${PWD}/bin. Either add ${PWD}/bin to your $PATH before all other entries, or use the commands directly, or use the commands through make (for example, make go-lint).

Optional environment:

  • GO: set an alternarive name for the Go compiler.

version.sh: Print The Current Version

Required environment:

  • CHANNEL: release channel, see above.

snap/: Snap GUI Files

App icons (see https://github.com/AdguardTeam/AdGuardHome/pull/1836), Snap manifest file templates, and helper scripts.

translations/: Twosky Integration Script

Usage

  • npm install: install dependencies. Run this first.
  • npm run locales:download: download and save all translations.
  • npm run locales:upload: upload the base en locale.
  • npm run locales:summary: show the current locales summary.
  • npm run locales:unused: show the list of unused strings.

After the download you'll find the output locales in the client/src/__locales/ directory.

whotracksme/: Whotracks.me Database Converter

A simple script that converts the Ghostery/Cliqz trackers database to a json format.

Usage

yarn install
node index.js

You'll find the output in the whotracksmedb.json file. Then, move it to client/src/helpers/trackers.