docker-documentation/docs/images/docker-nano-discord-bot.md

8.6 KiB
Executable File

title
nano-discord-bot

DEPRECATION NOTICE

This image is deprecated. We will not offer support for this image and it will not be updated.

linuxserver/nano-discord-bot

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Nano-discord-bot - A bot used to hook into a self hosted Nano RPC endpoint and discord server to Distribute funds from a faucet account.

Supported Architectures

Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lsiodev/nano-discord-bot should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture Tag
x86-64 amd64-latest
arm64 arm64v8-latest
armhf arm32v7-latest

Usage

Here are some example snippets to help you get started creating a container from this image.

docker

docker create \
  --name=nano-discord-bot \
  -e PUID=1000 \
  -e PGID=1000 \
  -e WALLET_URL=https://wallet.linuxserver.io/#/nano.linuxserver.io/ \
  -e RPC_URL=https://nano.linuxserver.io:7077 \
  -e FAUCET_KEY=XXXXXXXXXXXXX \
  -e DISCORD_KEY=XXXXXXXXXXXXX \
  -e FAUCET_AMOUNT="1000" \
  -v /path/to/data:/config \
  --restart unless-stopped \
  lsiodev/nano-discord-bot

docker-compose

Compatible with docker-compose v2 schemas.

---
version: "2.1"
services:
  nano-discord-bot:
    image: lsiodev/nano-discord-bot
    container_name: nano-discord-bot
    environment:
      - PUID=1000
      - PGID=1000
      - WALLET_URL=https://wallet.linuxserver.io/#/nano.linuxserver.io/
      - RPC_URL=https://nano.linuxserver.io:7077
      - FAUCET_KEY=XXXXXXXXXXXXX
      - DISCORD_KEY=XXXXXXXXXXXXX
      - FAUCET_AMOUNT="1000"
    volumes:
      - /path/to/data:/config
    restart: unless-stopped

Parameters

Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.

Ports (-p)

Parameter Function

Environment Variables (-e)

Env Function
PUID=1000 for UserID - see below for explanation
PGID=1000 for GroupID - see below for explanation
WALLET_URL=https://wallet.linuxserver.io/#/nano.linuxserver.io/ Hosted wallet endpoint to use.
RPC_URL=https://nano.linuxserver.io:7077 RPC endpoint to publish blocks to and ingest account information.
FAUCET_KEY=XXXXXXXXXXXXX The private key for your faucet account.
DISCORD_KEY=XXXXXXXXXXXXX Discord api key for the bot.
FAUCET_AMOUNT="1000" Amount to distribute to individual Discord users in Nano.

Volume Mappings (-v)

Volume Function
/config Database and Radarr configs

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Application Setup

With the proper environment variables passed to this container it will automatically reach out to your Nano RPC server and Discord Server. More about setting up a hosted Nano network here .

Docker Mods

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.

Support Info

  • Shell access whilst the container is running:
    • docker exec -it nano-discord-bot /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f nano-discord-bot
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' nano-discord-bot
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lsiodev/nano-discord-bot

Versions

  • 25.05.20: - Initial Release.