2018-01-31 23:35:54 +00:00
|
|
|
---
|
|
|
|
|
layout: page
|
|
|
|
|
title: Docker
|
|
|
|
|
---
|
2020-08-22 19:26:24 +00:00
|
|
|
**You'll need Docker installed before going any further. How to do so are out of scope of these docs, but you can find full instructions
|
2021-02-19 19:06:07 +00:00
|
|
|
for every operating system on the [Docker website](https://docs.docker.com/engine/install/).**
|
2018-01-31 23:35:54 +00:00
|
|
|
|
|
|
|
|
## Quick Start
|
|
|
|
|
|
2021-02-19 19:06:07 +00:00
|
|
|
- Generate some config for your BBS:
|
|
|
|
|
```
|
2022-01-24 20:57:03 +00:00
|
|
|
docker run -it -v "${HOME}/enigma-bbs/config:/enigma-bbs/config" enigmabbs/enigma-bbs:latest oputil.js config new
|
2021-02-19 19:06:07 +00:00
|
|
|
```
|
2018-01-31 23:35:54 +00:00
|
|
|
|
2021-02-19 19:06:07 +00:00
|
|
|
- Run it:
|
|
|
|
|
```
|
2022-01-24 20:57:03 +00:00
|
|
|
docker run -p 8888:8888 -v "${HOME}/enigma-bbs/config:/enigma-bbs/config" enigmabbs/enigma-bbs:latest
|
2021-02-19 19:06:07 +00:00
|
|
|
```
|
2018-01-31 23:35:54 +00:00
|
|
|
|
2022-01-24 20:57:03 +00:00
|
|
|
:bulb: Configuration will be stored in `${HOME}/enigma-bbs/config`.
|
2018-01-31 23:35:54 +00:00
|
|
|
|
2022-01-24 20:57:03 +00:00
|
|
|
:bulb: Windows users - you'll need to switch out `${HOME}/enigma-bbs/config` for a Windows-style path.
|
2020-08-22 19:26:24 +00:00
|
|
|
|
2021-02-19 19:06:07 +00:00
|
|
|
## Volumes
|
|
|
|
|
|
|
|
|
|
Containers by their nature are ephermeral. Meaning, stuff you want to keep (config, database, mail) needs
|
|
|
|
|
to be stored outside of the running container. As such, the following volumes are mountable:
|
|
|
|
|
|
|
|
|
|
| Volume | Usage |
|
|
|
|
|
|:------------------------|:---------------------------------------------------------------------|
|
|
|
|
|
| /enigma-bbs/art | Art, themes, etc |
|
|
|
|
|
| /enigma-bbs/config | Config such as config.hjson, menu.hjson, prompt.hjson, SSL certs etc |
|
|
|
|
|
| /enigma-bbs/db | ENiGMA databases |
|
|
|
|
|
| /enigma-bbs/filebase | Filebase |
|
|
|
|
|
| /enigma-bbs/logs | Logs |
|
|
|
|
|
| /enigma-bbs/mods | ENiGMA mods |
|
|
|
|
|
| /mail | FTN mail (for use with an external mailer) |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
## Building your own image
|
|
|
|
|
|
|
|
|
|
Customising the Docker image is easy!
|
|
|
|
|
|
|
|
|
|
1. Clone the ENiGMA-BBS source.
|
|
|
|
|
2. Build the image
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
docker build -f ./docker/Dockerfile .
|
2021-05-04 02:38:05 +00:00
|
|
|
```
|
