Dockerfile to build a CouchDB instance.
This is a work in progress and not stable for production use.
- About
- Maintainer
- Table of Contents
- Installation
- Configuration
- Maintenance
- Support
- License
- References
Clone this repository and build the image with docker build -t (imagename) .
Builds of the image are available on Docker Hub
docker pull docker.io/tiredofit/couchdb:(imagetag)
Builds of the image are also available on the Github Container Registry
docker pull ghcr.io/tiredofit/docker-couchdb:(imagetag)
The following image tags are available along with their tagged release based on what's written in the Changelog:
Container OS | Tag |
---|---|
Alpine | :latest |
Images are built primarily for amd64
architecture, and may also include builds for arm/v7
, arm64
and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)
-
The quickest way to get started is using docker-compose. See the examples folder for a working docker-compose.yml that can be modified for development or production use.
-
Set various environment variables to understand the capabilities of this image.
-
Map persistent storage for access to configuration and data files for backup.
The following directories are used for configuration and can be mapped for persistent storage.
Directory | Description |
---|---|
/data |
Database directory |
/config |
Configuration directory |
/logs |
Logs storage |
This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp
. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash
,curl
,less
,logrotate
,nano
.
Be sure to view the following repositories to understand all the customizable options:
Image | Description |
---|---|
OS Base | Customized Image based on Alpine Linux |
Parameter | Description | Default |
---|---|---|
ADMIN_USER |
Admin User | admin |
ADMIN_PASS |
Admin Password | admin |
CONFIG_PATH |
Configuration file path | /config/ |
DATA_PATH |
Database file path | /data/ |
ENABLE_SOFT_DELETE |
Soft Delete databases instead of deleting hard | FALSE |
INDEX_PATH |
Index Path | /data/ |
LISTEN_PORT |
Listening Port | 5984 |
LOG_TYPE |
Log Type CONSOLE or FILE |
FILE |
LOG_FILE |
Log Filename | couchdb.log |
LOG_LEVEL |
Log Level | INFO |
LOG_PATH |
Log Path | /logs/ |
COMPRESSION_TYPE |
File compresstion algorithm | snappy |
NODE_MODE |
SINGLE only at this time |
SINGLE |
Port | Description |
---|---|
5984 |
CouchDB |
For debugging and maintenance purposes you may want access the containers shell.
docker exec -it (whatever your container name is) bash
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
- The Discussions board is a great place for working with the community on tips and tricks of using this image.
- Consider sponsoring me for personalized support
- Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- Consider sponsoring me regarding development of features.
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- Consider sponsoring me for up to date releases.
MIT. See LICENSE for more details.