kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
c3a0cebcba
commit
7cd9496ac9
|
|
@ -1,22 +1,28 @@
|
||||||
# [lsiodev/gmail-order-bot](https://github.com/linuxserver/docker-gmail-order-bot)
|
---
|
||||||
|
title: gmail-order-bot
|
||||||
|
---
|
||||||
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||||||
|
<!-- Please read the https://github.com/lsiodev/docker-gmail-order-bot/blob/master/.github/CONTRIBUTING.md -->
|
||||||
|
|
||||||
[](https://github.com/linuxserver/docker-gmail-order-bot)
|
# [lsiodev/gmail-order-bot](https://github.com/lsiodev/docker-gmail-order-bot)
|
||||||
[](https://github.com/linuxserver/docker-gmail-order-bot/releases)
|
|
||||||
[](https://github.com/linuxserver/docker-gmail-order-bot/packages)
|
[](https://scarf.sh/gateway/lsiodev-ci/docker/lsiodev%2Fgmail-order-bot)
|
||||||
[](https://gitlab.com/Linuxserver.io/docker-gmail-order-bot/container_registry)
|
[](https://github.com/lsiodev/docker-gmail-order-bot)
|
||||||
[](https://microbadger.com/images/lsiodev/gmail-order-bot "Get your own version badge on microbadger.com")
|
[](https://github.com/lsiodev/docker-gmail-order-bot/releases)
|
||||||
|
[](https://github.com/lsiodev/docker-gmail-order-bot/packages)
|
||||||
|
[](https://gitlab.com/linuxserver.io/docker-gmail-order-bot/container_registry)
|
||||||
|
[](https://quay.io/repository/linuxserver.io/gmail-order-bot)
|
||||||
[](https://hub.docker.com/r/lsiodev/gmail-order-bot)
|
[](https://hub.docker.com/r/lsiodev/gmail-order-bot)
|
||||||
[](https://hub.docker.com/r/lsiodev/gmail-order-bot)
|
[](https://hub.docker.com/r/lsiodev/gmail-order-bot)
|
||||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-gmail-order-bot/job/master/)
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-gmail-order-bot/job/master/)
|
||||||
|
|
||||||
[Gmail-order-bot](https://developers.google.com/gmail/api) - A bot used to leverage a Gmail account as an order messaging service to consume email orders from [Nano Checkout](https://github.com/linuxserver/nano-checkout) and process them using any custom logic you choose.
|
[Gmail-order-bot](https://developers.google.com/gmail/api) - A bot used to leverage a Gmail account as an order messaging service to consume email orders from [Nano Checkout](https://github.com/linuxserver/nano-checkout) and process them using any custom logic you choose.
|
||||||
|
|
||||||
|
|
||||||
## Supported Architectures
|
## 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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||||
|
|
||||||
Simply pulling `ghcr.io/lsiodev/gmail-order-bot` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
Simply pulling `lscr.io/lsiodev/gmail-order-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:
|
The architectures supported by this image are:
|
||||||
|
|
||||||
|
|
@ -26,105 +32,6 @@ The architectures supported by this image are:
|
||||||
| arm64 | arm64v8-latest |
|
| arm64 | arm64v8-latest |
|
||||||
| armhf | arm32v7-latest |
|
| armhf | arm32v7-latest |
|
||||||
|
|
||||||
|
|
||||||
## Usage
|
|
||||||
|
|
||||||
Here are some example snippets to help you get started creating a container from this image.
|
|
||||||
|
|
||||||
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
|
|
||||||
|
|
||||||
Compatible with docker-compose v2 schemas.
|
|
||||||
|
|
||||||
```yaml
|
|
||||||
---
|
|
||||||
version: "2.1"
|
|
||||||
services:
|
|
||||||
gmail-order-bot:
|
|
||||||
image: ghcr.io/lsiodev/gmail-order-bot
|
|
||||||
container_name: gmail-order-bot
|
|
||||||
environment:
|
|
||||||
- PUID=1000
|
|
||||||
- PGID=1000
|
|
||||||
- BOT_NAME=discord
|
|
||||||
- LOOP_TIME=60
|
|
||||||
volumes:
|
|
||||||
- /path/to/data:/config
|
|
||||||
restart: unless-stopped
|
|
||||||
```
|
|
||||||
|
|
||||||
### docker cli
|
|
||||||
|
|
||||||
```
|
|
||||||
docker run -d \
|
|
||||||
--name=gmail-order-bot \
|
|
||||||
-e PUID=1000 \
|
|
||||||
-e PGID=1000 \
|
|
||||||
-e BOT_NAME=discord \
|
|
||||||
-e LOOP_TIME=60 \
|
|
||||||
-v /path/to/data:/config \
|
|
||||||
--restart unless-stopped \
|
|
||||||
ghcr.io/lsiodev/gmail-order-bot
|
|
||||||
```
|
|
||||||
|
|
||||||
|
|
||||||
## 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 |
|
|
||||||
| `BOT_NAME=discord` | On successful order receive send the order payload to this bot (default bots are located in root/defaults/bots) |
|
|
||||||
| `LOOP_TIME=60` | Time in seconds to reach into gmail and get new messages to process |
|
|
||||||
|
|
||||||
### Volume Mappings (`-v`)
|
|
||||||
|
|
||||||
| Volume | Function |
|
|
||||||
| :----: | --- |
|
|
||||||
| `/config` | Path to gmail tokens and custom/default bots |
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
## 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](https://en.wikipedia.org/wiki/Umask) 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
|
## Application Setup
|
||||||
|
|
||||||
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.
|
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.
|
||||||
|
|
@ -167,14 +74,109 @@ In order to use this bot you will need to perform the following setup steps:
|
||||||
|
|
||||||
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.
|
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.
|
From there the bot will loop in for your defined timeout and pull in emails and spit out orders to your destination.
|
||||||
|
|
||||||
|
## Usage
|
||||||
|
|
||||||
|
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
|
||||||
|
|
||||||
|
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
---
|
||||||
|
version: "2.1"
|
||||||
|
services:
|
||||||
|
gmail-order-bot:
|
||||||
|
image: lscr.io/lsiodev/gmail-order-bot
|
||||||
|
container_name: gmail-order-bot
|
||||||
|
environment:
|
||||||
|
- PUID=1000
|
||||||
|
- PGID=1000
|
||||||
|
- BOT_NAME=discord
|
||||||
|
- LOOP_TIME=60
|
||||||
|
volumes:
|
||||||
|
- /path/to/data:/config
|
||||||
|
restart: unless-stopped
|
||||||
|
```
|
||||||
|
|
||||||
|
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
|
||||||
|
|
||||||
|
```bash
|
||||||
|
docker run -d \
|
||||||
|
--name=gmail-order-bot \
|
||||||
|
-e PUID=1000 \
|
||||||
|
-e PGID=1000 \
|
||||||
|
-e BOT_NAME=discord \
|
||||||
|
-e LOOP_TIME=60 \
|
||||||
|
-v /path/to/data:/config \
|
||||||
|
--restart unless-stopped \
|
||||||
|
lscr.io/lsiodev/gmail-order-bot
|
||||||
|
```
|
||||||
|
|
||||||
|
## 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 |
|
||||||
|
| `BOT_NAME=discord` | On successful order receive send the order payload to this bot (default bots are located in root/defaults/bots) |
|
||||||
|
| `LOOP_TIME=60` | Time in seconds to reach into gmail and get new messages to process |
|
||||||
|
|
||||||
|
### Volume Mappings (`-v`)
|
||||||
|
|
||||||
|
| Volume | Function |
|
||||||
|
| :----: | --- |
|
||||||
|
| `/config` | Path to gmail tokens and custom/default bots |
|
||||||
|
|
||||||
|
#### Miscellaneous Options
|
||||||
|
|
||||||
|
| Parameter | Function |
|
||||||
|
| :-----: | --- |
|
||||||
|
|
||||||
|
## Environment variables from files (Docker secrets)
|
||||||
|
|
||||||
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||||||
|
|
||||||
|
As an example:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
-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](https://en.wikipedia.org/wiki/Umask) 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:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ id username
|
||||||
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||||||
|
```
|
||||||
|
|
||||||
## Docker Mods
|
## Docker Mods
|
||||||
|
|
||||||
[](https://mods.linuxserver.io/?mod=gmail-order-bot "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
[](https://mods.linuxserver.io/?mod=gmail-order-bot "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||||||
|
|
||||||
We publish various [Docker Mods](https://github.com/linuxserver/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.
|
We publish various [Docker Mods](https://github.com/lsiodev/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.
|
||||||
|
|
||||||
|
|
||||||
## Support Info
|
## Support Info
|
||||||
|
|
||||||
|
|
@ -185,7 +187,7 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
|
||||||
* Container version number
|
* Container version number
|
||||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' gmail-order-bot`
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' gmail-order-bot`
|
||||||
* Image version number
|
* Image version number
|
||||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/lsiodev/gmail-order-bot`
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/lsiodev/gmail-order-bot`
|
||||||
|
|
||||||
## Versions
|
## Versions
|
||||||
|
|
||||||
|
|
|
||||||
Ładowanie…
Reference in New Issue