A worker is a computer program that runs as a background process on a machine. This could be a server, an embedded systems or your laptop. The worker executes the tasks of a workflow.
Jump to [3bot main repo](https://github.com/3bot/3bot/).
## Setup/Installation
$ pip install threebot-worker
$ threebot-worker start
## Configuration
The configuration file contains all the configuration of your threebot-worker installation.
This section explains which parameter are available.
The configuration file is located in `~/3bot/config.ini`. If you installed 3bot in an own virtualenv it
is located in `<path to virtualenv>/3bot/config.ini`
You don't need to create a configuration file by yourself. When you first run the threebot-worker, you will be asked to enter values for the required settings.
### Available settings
#### BOT_ENDPOINT
required: True
default: *
List of hosts the worker should accept connections from (this is not well tested yet)
#### PORT
required: True
default: None
Port number the worker listens. This Port should be openend by your firewall. The port number from the 3bot application and threebot-worker settings must match.
#### SECRET_KEY
required: True
default: None
The secret key is used to establish a secure connection from the 3bot application to the threebot-worker. The secret key from the 3bot application and threebot-worker settings must match.
**Never share your your secret key!**
#### LOGFILE
required: False
default: `~/3bot/3bot.log`
Path to the logfile. theebot-worker will log all incomming connections, performed workflows and errors.
#### LOGLEVEL
required: False
default: `CRITICAL`
Valid values for `LOGLEVEL` could be taken from [here](https://docs.python.org/2/howto/logging.html).
### Example for `confing.ini`
[3bot-settings]
BOT_ENDPOINT = *
PORT = 55556
SECRET_KEY = <YOUR SECRET KEY>
LOGFILE = /var/log/3bot-worker.log
LOGLEVEL = DEBUG
## Changelog
see [CHANGELOG.md](https://github.com/3bot/3bot-worker/blob/master/CHANGELOG.md)
Metadata
Release files for threebot-worker 0.1.4
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| threebot-worker-0.1.4.tar.gz | 6.9 kB | Without provenance | Details for threebot-worker-0.1.4.tar.gz |
Release files / threebot-worker-0.1.4.tar.gz
| Download URL | threebot-worker-0.1.4.tar.gz |
|---|---|
| Size | 6.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
534f54646881f3249d8c6d39ab841c9f8a20f3242fe18f14cc8a17e60bfe6bf9
|
|
BLAKE2b-256 checksum How to use checksums |
0e57397c2ea110636885173c09fe1f47f2910a316b0f50f90b1a413a76e43590
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
Security for threebot-worker 0.1.4
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.