-
Notifications
You must be signed in to change notification settings - Fork 9
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
9 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -18,13 +18,11 @@ This repository contains the scripts used to automatically generate the list of | |
|
||
## Running with docker | ||
|
||
|
||
|
||
### Environment variables | ||
|
||
Name | Default | Description | ||
-----| ------- | ------- | ||
`CRAWL_GIT_REPO` | `https://github.com/skylenet/discv4-dns-lists.git` | Git repository `used to clone and push the node list | ||
`CRAWL_GIT_REPO` | `https://github.com/ethereum/discv4-dns-lists.git` | Git repository `used to clone and push the node list | ||
`CRAWL_GIT_BRANCH` | `master` | Git branch used for the fetch and push | ||
`CRAWL_GIT_PUSH` | `false` | When set to `true`, it will push the node lists to the git repository | ||
`CRAWL_GIT_USER` | `crawler` | Git username. Will appear in the commit messages. | ||
|
@@ -64,7 +62,13 @@ $ docker run -it \ | |
-v "$HOME/.ssh/crawler:/root/.ssh" \ # Needed if you use git via SSH | ||
-v "$HOME/secrets/secret-signing-key.json:/secrets/key.json" \ # Only needed if you want to sign the node lists | ||
-e CRAWL_TIMEOUT=10m \ # Specify your custom timeout | ||
-e [email protected]:skylenet/discv4-dns-lists.git \ # Use SSH instead of HTTPS | ||
-e [email protected]:ethereum/discv4-dns-lists.git \ # Use SSH instead of HTTPS | ||
-e CRAWL_GIT_PUSH=true \ # Specify that we want to push the changes | ||
skylenet/discv4-crawl | ||
ghcr.io/ethereum/discv4-crawl:master | ||
``` | ||
|
||
## Development | ||
|
||
|
||
### Contributing with a Pull Request | ||
This repository uses [conventional commits](https://www.conventionalcommits.org/en/v1.0.0/) for commit messages, so that we can automatically generate release and the respective changelog. Make sure to follow the specification on the PR title. |