Customising the Faucet

What?

This page describes how to configure the neo-local-faucet container that is within the neo-local stack.

Default Setup

neo-faucet: 
  container_name: neo-faucet
  depends_on: 
    - neo-scan
  environment: 
    NEOSCAN: "neo-scan:4000"
  image: cityofzion/neo-local-faucet
  links: 
    - "neo-scan:4000"
  ports: 
    - "4002:4002"

The standard setup has the port opened at 4002 and is connected to the NeoScan instance over the neo-scan:4000 address.

Customisable Parameters

Per the documentation of the neo-local-faucet repo, the following parameters can be edited:

• Admin account
• Block wait time
• Faucet URL and port
• NEO and GAS rewards
• NeoScan URL

Use the environment variables in the docker-compose.yml to push them to the neo-local-faucet application.

Note: if the faucet isn't used locally, it is advised to edit FAUCET_ADDRESS to avoid CORS issues.

Example

The following setup has changed the port, reward size and block wait time

neo-faucet: 
  container_name: neo-faucet
  depends_on: 
    - neo-scan
  environment: 
    GAS_REWARD: "5000"
    NEO_REWARD: "1000"
    NEOSCAN: "neo-scan:4000"
    MIN_BLOCK: "30000"
    PORT: "4200"
  image: cityofzion/neo-local-faucet
  links: 
    - "neo-scan:4000"
  ports: 
    - "4200:4200"

Note: if you change the PORT, do make sure you edit the ports section as well (as shown in this example)