0e84962fde
Merge in DNS/adguard-home from 2276-releases to master Updates #2276. Squashed commit of the following: commit 84961947c51477aae53606ec6e2e0cce0bdfc139 Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:36:13 2020 +0300 all: fix github build commit 54af2adbf2f433e80393fb142e66ba6b3a78b13e Author: Ainar Garipov <A.Garipov@AdGuard.COM> Date: Wed Dec 30 14:34:02 2020 +0300 all: remove old Dockerfile, improve build scripts commit 99bb2f2ba1458d32074ac0911b5c02ce6669e43e Merge: 2292b677a |
||
|---|---|---|
| .. | ||
| hooks | ||
| make | ||
| querylog | ||
| snap | ||
| translations | ||
| whotracksme | ||
| install.sh | ||
| 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'sadguardhome-dev.DOCKER_OUTPUT: the--outputparameters. By default they aretype=image,name=${DOCKER_IMAGE_NAME},push=false.SUDO: allow users to usesudoordoaswithdocker. By default none is used.
build-release.sh: Build A Release For All Platforms
Required environment:
CHANNEL: release channel, see above.GPG_KEYandGPG_KEY_PASSPHRASE: data forgpg. Only required ifSIGNis1.
Optional environment:
DIST_DIR: the directory to build a release into. The default value isdist.GO: set an alternarive name for the Go compiler.SIGN:0to not sign the resulting packages,1to sign. The default value is1.VERBOSE:1to be verbose,2to also print environment. This script callsgo-build.shwith the verbosity level one level lower, so to get verbosity level2ingo-build.sh, set this to3when callingbuild-release.sh.VERSION: release version. Will be set byversion.shif it is unset or it has the defaultMakefilevalue ofv0.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.1shows every command that is run and every Go package that is processed.2also shows subcommands and environment. The default value is0, 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.1shows every command that is run and every Go package that is processed.2also shows subcommands and environment. The default value is0, 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 to0, don't exit the script after the first encountered error. The default value is1.GO: set an alternarive name for the Go compiler.VERBOSE: verbosity level.1shows every command that is run.2also shows subcommands. The default value is0, don't be verbose.
go-test.sh: Run Backend Tests
Optional environment:
GO: set an alternarive name for the Go compiler.RACE: set to0to not use the Go race detector. The default value is1, use the race detector.VERBOSE: verbosity level.1shows every command that is run and every Go package that is processed.2also shows subcommands. The default value is0, 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 baseenlocale.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.