README.md

Nine Chronicles | Development Tool

nodeManager

This project provides a quick auto-updatable solution for a Nine Chronicles node, for development purposes.

Features:

• Auto-updates based on this URL: https://download.nine-chronicles.com/apv.json
• Auto downloads snapshot
• Generates new docker container as a node
• Demo Account
  • I have created and provided a demo account for development purposes only. Please do not change the password but you are welcome to change other things for your testing purposes. You can of course use a different account by changing the PrivateKey in the settings.conf file.

Requirements

• Docker
• VS Code
  • https://code.visualstudio.com/download
• VS Code Extension: Remote Containers
  • https://marketplace.visualstudio.com/items?itemName=ms-vscode-remote.remote-containers

Usage

Method 1: Instant Deploy via CMD

# Example using default settings & demo account
docker run -d -v "/var/run/docker.sock:/var/run/docker.sock" \
--name nodeManager cryptokasm/9c-nodemanager:latest

# Example using custom settings or personal account
docker run -d -v "/var/run/docker.sock:/var/run/docker.sock" \
--name nodeManager cryptokasm/9c-nodemanager:latest \
--privatekey=000000000000 \
--graphql-port=23070 \
--peer-port=31270
--cors-policy=false

Method 2: Instant Deploy via docker-compose.yml

# Example using default settings & demo account
services:
  nodeManager:
    image: cryptokaksm/9c-nodemanager
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock

# Example using custom settings or personal account
services:
  nodeManager:
    image: cryptokaksm/9c-nodemanager
    volumes:
      - /var/run/docker.sock:/var/run/docker.sock
    command: [
      '--privatekey=000000000000',
      '--graphql-port=23070',
      '--peer-port=31270',
      '--cors-policy=true'
    ]

# Default Settings

# Enable/Disable Debugging
DEBUG=true

# Nine Chronicles Private Key **KEEP SECRET**
PRIVATE_KEY=000000000000

# GraphQL Forwarding Port
GRAPHQL_PORT=23070

# Peer Forwarding Port
PEER_PORT=31270

# Enable/Disable CORS Policy
CORS_POLICY=false

# Set MAX RAM Per Miner **PROTECTION FROM MEMORY LEAKS**
RAM_LIMIT=4096M

# Set MIN RAM Per Miner **SAVES RESOURCES FOR THAT CONTAINER**
RAM_RESERVE=2048M

# Refresh Snapshot each run
REFRESH_SNAPSHOT=1

# Enable GraphQL Query Commands
GRAPHQL_QUERIES=1

Method 3: Build Image & Deploy

1. Clone from Github
  git clone https://github.com/CryptoKasm/9c-nodemanager.git

2. Open project in VS Code

3. Click ICON in lower left corner > Remote-Containers: Reopen in container

4. Start Developing
- ./nodeManager.sh          # Runs 9c-node
- ./nodeManager.sh --build  # Builds docker-image
- ./nodeManger.sh --run     # Runs built docker-image

References

COMING SOON

Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate.

Community & Support

Come join us in the community Discord server! If you have any questions, don't hesitate to ask!

• Planetarium - Discord

Support & Bug Reports

• CrytpoKasm - Discord

License

GNU GPLv3