The LinuxServer.io team brings you another container release featuring:
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at:
- Blog - all the things you can do with our containers including How-To guides, opinions and much more!
- Discord - realtime support / chat with the community and the team.
- Discourse - post on our community forum.
- Fleet - an online web interface which displays all of our maintained images.
- GitHub - view the source for all of our repositories.
- Open Collective - please consider helping us by either donating or contributing to our budget
This image is deprecated. We will not offer support for this image and it will not be updated.
Gmail-order-bot - A bot used to leverage a Gmail account as an order messaging service to consume email orders from Nano Checkout and process them using any custom logic you choose.
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/lsiodev/gmail-order-bot:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
This container is for developers only! We make pre-defined bots we use in our workflow, but you have to have an underlying understanding of javascript and some basic Docker skills to use it.
The entire basis of this is to act as middleware between your email address receiving orders from https://checkout.linuxserver.io and send them to some external service. The bot will archive any messages that do not come from [email protected] with valid DKIM signatures, so definetly do not use this on a personal account.
The concept behind this bot and using email as a destination for orders is to serve normal users that simply want an email for an order out of the box and provide a free messaging queue akin to something like RabbitMQ for people that want to automate order ingestion.
By default we include bots we use that will be copied over on first container run, for example a simple discord ping when an order is received with the order details:
const Discord = require('discord.js');
const YAML = require('yaml');
const discordtoken = process.env.DISCORD_TOKEN;
const roomid = process.env.DISCORD_ROOM
exports.orderbot = async function(order) {
return new Promise(resolve => {
const client = new Discord.Client();
client.login(discordtoken);
client.on('ready', async () => {
delete order.rawpayload
await client.channels.cache.get(roomid.toString()).send(YAML.stringify(order));
client.destroy();
resolve(true)
})
});
}
This code will be passed an order object containing all the order details parsed from the email message. Here we use custom env variables to set application settings to connect up to and send a message to discord.
In order to use this bot you will need to perform the following setup steps:
- Create a dedicated gmail account to use for https://checkout.linuxserver.io
- Enable API access to this Gmail account by clicking on
Enable the Gmail APIhere https://developers.google.com/gmail/api/quickstart/nodejs - Save your credentials.json file from that action to the folder you will be bind mounting as
/config - Run
docker run --rm -it -u $(id -u ${USER}):$(id -g ${USER}) -v /path/to/data:/config --entrypoint /config.sh lsiodev/gmail-order-bot - Go to the URL prompted and enter the key you get from it.
- Start the container using the run/compose example in this readme.
When the container starts if you are using a custom bot located in /config/bots it will install the node modules included in it's package.json, do not use system level node modules this container is Alpine based and it will cause conflicts.
From there the bot will loop in for your defined timeout and pull in emails and spit out orders to your destination.
Here are some example snippets to help you get started creating a container.
docker-compose (recommended, click here for more info)
---
version: "2.1"
services:
gmail-order-bot:
image: lscr.io/lsiodev/gmail-order-bot:latest
container_name: gmail-order-bot
environment:
- PUID=1000
- PGID=1000
- TZ=Etc/UTC
- BOT_NAME=discord
- LOOP_TIME=60
volumes:
- /path/to/data:/config
restart: unless-stoppeddocker cli (click here for more info)
docker run -d \
--name=gmail-order-bot \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Etc/UTC \
-e BOT_NAME=discord \
-e LOOP_TIME=60 \
-v /path/to/data:/config \
--restart unless-stopped \
lscr.io/lsiodev/gmail-order-bot:latest
Container 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.
| Parameter | Function |
|---|---|
-e PUID=1000 |
for UserID - see below for explanation |
-e PGID=1000 |
for GroupID - see below for explanation |
-e TZ=Etc/UTC |
specify a timezone to use, see this list. |
-e BOT_NAME=discord |
On successful order receive send the order payload to this bot (default bots are located in root/defaults/bots) |
-e LOOP_TIME=60 |
Time in seconds to reach into gmail and get new messages to process |
-v /config |
Path to gmail tokens and custom/default bots |
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
-e FILE__PASSWORD=/run/secrets/mysecretpasswordWill set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
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.
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)
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
- Shell access whilst the container is running:
docker exec -it gmail-order-bot /bin/bash - To monitor the logs of the container in realtime:
docker logs -f gmail-order-bot - container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' gmail-order-bot
- image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/lsiodev/gmail-order-bot:latest
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the Application Setup section above to see if it is recommended for the image.
Below are the instructions for updating containers:
- Update all images:
docker-compose pull- or update a single image:
docker-compose pull gmail-order-bot
- or update a single image:
- Let compose update all containers as necessary:
docker-compose up -d- or update a single container:
docker-compose up -d gmail-order-bot
- or update a single container:
- You can also remove the old dangling images:
docker image prune
- Update the image:
docker pull lscr.io/lsiodev/gmail-order-bot:latest - Stop the running container:
docker stop gmail-order-bot - Delete the container:
docker rm gmail-order-bot - Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your
/configfolder and settings will be preserved) - You can also remove the old dangling images:
docker image prune
-
Pull the latest image at its tag and replace it with the same env variables in one run:
docker run --rm \ -v /var/run/docker.sock:/var/run/docker.sock \ containrrr/watchtower \ --run-once gmail-order-bot
-
You can also remove the old dangling images:
docker image prune
Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using Docker Compose.
- We recommend Diun for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
If you want to make local modifications to these images for development purposes or just to customize the logic:
git clone https://github.com/lsiodev/docker-gmail-order-bot.git
cd docker-gmail-order-bot
docker build \
--no-cache \
--pull \
-t lscr.io/lsiodev/gmail-order-bot:latest .The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
docker run --rm --privileged multiarch/qemu-user-static:register --resetOnce registered you can define the dockerfile to use with -f Dockerfile.aarch64.
- 24.09.23: - Deprecate.
- 06.07.20: - Initial Release.
