Change a few minor formatting bits
This commit is contained in:
parent
967999069e
commit
5be9766841
|
|
@ -10,7 +10,9 @@ Eggdrop is the world's most popular Open Source IRC bot, designed for flexibilit
|
|||
|
||||
To run this container the first time, you'll need to pass in, at minimum, a nickname and server via Environmental Variables. At minimum, a docker run command similar to
|
||||
|
||||
docker run -ti -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/for/host/data:/home/eggdrop/eggdrop/data eggdrop:latest
|
||||
```console
|
||||
$ docker run -ti -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/for/host/data:/home/eggdrop/eggdrop/data eggdrop:latest
|
||||
```
|
||||
|
||||
should be used. This will modify the appropriate values within the config file, then start your bot with the nickname FooBot and connect it to irc.freenode.net.
|
||||
|
||||
|
|
@ -20,7 +22,9 @@ These variables are only needed for your first run- after the first use, you can
|
|||
|
||||
After running the eggdrop container for the first time, the configuration file, user file and channel file will all be available inside the container at /home/eggdrop/eggdrop/data/ . NOTE! These files are only as persistent as the container they exist in. If you expect to use a different container over the course of using the Eggdrop docker image (intentionally or not) you will want to create a persistent data store. The easiest way to do this is to mount a directory on your host machine to /home/eggdrop/eggdrop/data. If you do this prior to your first run, you can easily edit the eggdrop configuration file on the host. Otherwise, you can also drop in existing config, user, or channel files into the mounted directory for use in the eggdrop container. You'll also likely want to daemonize eggdrop (ie, run it in the background). To do this, start your container with something similar to
|
||||
|
||||
docker run -i -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/to/eggdrop/files:/home/eggdrop/eggdrop/data -d eggdrop:latest
|
||||
```console
|
||||
$ docker run -i -e NICK=FooBot -e SERVER=irc.freenode.net -v /path/to/eggdrop/files:/home/eggdrop/eggdrop/data -d eggdrop:latest
|
||||
```
|
||||
|
||||
Please note that, even in daemon mode, the -i flag for docker run is required.
|
||||
|
||||
|
|
|
|||
|
|
@ -10,27 +10,37 @@ Spiped (pronounced "ess-pipe-dee") is a utility for creating symmetrically encry
|
|||
|
||||
This image automatically takes the key from the `/spiped/key` file (`-k`) and runs spiped in foreground (`-F`). Other than that it takes the same options *spiped* itself does. You can list the available flags by running the image without arguments:
|
||||
|
||||
$ docker run -it --rm spiped
|
||||
usage: spiped {-e | -d} -s <source socket> -t <target socket> -k <key file>
|
||||
[-DFj] [-f | -g] [-n <max # connections>] [-o <connection timeout>]
|
||||
[-p <pidfile>] [-r <rtime> | -R]
|
||||
```console
|
||||
$ docker run -it --rm spiped
|
||||
usage: spiped {-e | -d} -s <source socket> -t <target socket> -k <key file>
|
||||
[-DFj] [-f | -g] [-n <max # connections>] [-o <connection timeout>]
|
||||
[-p <pidfile>] [-r <rtime> | -R]
|
||||
```
|
||||
|
||||
For example running spiped to take encrypted connections on port 8025 and forward them to port 25 on localhost would look like this:
|
||||
|
||||
$ docker run -d -v /path/to/keyfile:/spiped/key:ro -p 8025:8025 spiped -d -s '[0.0.0.0]:8025' -t '[127.0.0.1]:25'
|
||||
```console
|
||||
$ docker run -d -v /path/to/keyfile:/spiped/key:ro -p 8025:8025 spiped -d -s '[0.0.0.0]:8025' -t '[127.0.0.1]:25'
|
||||
```
|
||||
|
||||
Usually you would combine this image with another linked container. The following example would take encrypted connections on port 9200 and forward them to port 9200 in the container with the name `elasticsearch`:
|
||||
|
||||
$ docker run -d -v /path/to/keyfile:/spiped/key:ro -p 9200:9200 --link elasticsearch:elasticsearch spiped -d -s '[0.0.0.0]:9200' -t 'elasticsearch:9200'
|
||||
```console
|
||||
$ docker run -d -v /path/to/keyfile:/spiped/key:ro -p 9200:9200 --link elasticsearch:elasticsearch spiped -d -s '[0.0.0.0]:9200' -t 'elasticsearch:9200'
|
||||
```
|
||||
|
||||
If you don’t need any to bind to a privileged port you can pass `--user spiped` to make *spiped* run as an unprivileged user:
|
||||
|
||||
$ docker run -d -v /path/to/keyfile:/spiped/key:ro --user spiped -p 9200:9200 --link elasticsearch:elasticsearch spiped -d -s '[0.0.0.0]:9200' -t 'elasticsearch:9200'
|
||||
```console
|
||||
$ docker run -d -v /path/to/keyfile:/spiped/key:ro --user spiped -p 9200:9200 --link elasticsearch:elasticsearch spiped -d -s '[0.0.0.0]:9200' -t 'elasticsearch:9200'
|
||||
```
|
||||
|
||||
### Generating a key
|
||||
|
||||
You can save a new keyfile named `spiped-keyfile` to the folder `/path/to/keyfile/` by running:
|
||||
|
||||
$ docker run -it --rm -v /path/to/keyfile:/spiped/key spiped spiped-generate-key.sh
|
||||
```console
|
||||
$ docker run -it --rm -v /path/to/keyfile:/spiped/key spiped spiped-generate-key.sh
|
||||
```
|
||||
|
||||
Afterwards transmit `spiped-keyfile` securely to another host (e.g. by using scp).
|
||||
|
|
|
|||
Loading…
Reference in New Issue