2020-04-28 15:23:37 +00:00
# linuxserver/codimd
2019-06-10 02:33:14 +00:00
2020-04-28 15:23:37 +00:00
[![GitHub Stars ](https://img.shields.io/github/stars/linuxserver/docker-codimd.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-codimd) [![GitHub Release ](https://img.shields.io/github/release/linuxserver/docker-codimd.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-codimd/releases) [![GitHub Package Repository ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF )](https://github.com/linuxserver/docker-codimd/packages) [![GitLab Container Registry ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF )](https://gitlab.com/Linuxserver.io/docker-codimd/container_registry) [![Quay.io ](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io )](https://quay.io/repository/linuxserver.io/codimd) [![MicroBadger Layers ](https://img.shields.io/microbadger/layers/linuxserver/codimd.svg?style=flat-square&color=E68523 )](https://microbadger.com/images/linuxserver/codimd) [![Docker Pulls ](https://img.shields.io/docker/pulls/linuxserver/codimd.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/codimd) [![Docker Stars ](https://img.shields.io/docker/stars/linuxserver/codimd.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF )](https://hub.docker.com/r/linuxserver/codimd) [![Build Status ](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-codimd/job/master/badge/icon?style=flat-square )](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-codimd/job/master/) [![ ](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/badge.svg )](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/codimd/latest/index.html)
2019-06-10 02:33:14 +00:00
2020-04-28 15:23:37 +00:00
[Codimd ](https://demo.codimd.org ) gives you access to all your files wherever you are.
2019-10-02 05:09:41 +00:00
2020-04-28 15:23:37 +00:00
CodiMD is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your desktop, tablet or even on the phone. You can sign-in via multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
2019-06-10 02:33:14 +00:00
## Supported Architectures
2019-09-04 05:09:45 +00:00
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/ ).
2019-06-10 02:33:14 +00:00
Simply pulling `linuxserver/codimd` 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:
| Architecture | Tag |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-06-10 02:33:14 +00:00
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
2020-04-28 15:23:37 +00:00
```text
2019-06-10 02:33:14 +00:00
docker create \
--name=codimd \
-e PUID=1000 \
-e PGID=1000 \
-e DB_HOST=< hostname or ip > \
-e DB_PORT=3306 \
-e DB_USER=codimd \
-e DB_PASS=< secret password > \
-e DB_NAME=codimd \
-e TZ=Europe/London \
-p 3000:3000 \
-v < /path/to/appdata>:/config \
--restart unless-stopped \
linuxserver/codimd
```
### docker-compose
Compatible with docker-compose v2 schemas.
```yaml
version: "3"
services:
mariadb:
image: linuxserver/mariadb:latest
container_name: codimd_mariadb
restart: always
volumes:
- < path to mariadb data > :/config
environment:
- MYSQL_ROOT_PASSWORD=< secret password >
- MYSQL_DATABASE=codimd
- MYSQL_USER=codimd
- MYSQL_PASSWORD=< secret password >
- PGID=1000
- PUID=1000
- TZ=Europe/London
codimd:
image: linuxserver/codimd:latest
container_name: codimd
restart: always
depends_on:
- mariadb
volumes:
- < path to config > :/config
environment:
- DB_HOST=mariadb
- DB_USER=codimd
- DB_PASS=< secret password >
- DB_NAME=codimd
- DB_PORT=3306
- PGID=1000
- PUID=1000
- TZ=Europe/London
ports:
- "3000:3000"
```
## Parameters
2020-04-28 15:23:37 +00:00
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.
2019-06-10 02:33:14 +00:00
2020-04-28 15:23:37 +00:00
### Ports \(`-p`\)
2019-06-10 02:33:14 +00:00
| Parameter | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
| `3000` | If you wish to access this container from [http://{IP}:${PORT}\` ](http://{IP}:${PORT}` ) this _must_ be left unchanged. |
2019-06-10 02:33:14 +00:00
2020-04-28 15:23:37 +00:00
### Environment Variables \(`-e`\)
2019-06-10 02:33:14 +00:00
| Env | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-06-10 02:33:14 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
| `DB_HOST=<hostname or ip>` | Host address of mysql database |
| `DB_PORT=3306` | Port to access mysql database default is 3306 |
| `DB_USER=codimd` | Database user |
| `DB_PASS=<secret password>` | Database password |
| `DB_NAME=codimd` | Database name |
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
2020-04-28 15:23:37 +00:00
### Volume Mappings \(`-v`\)
2019-06-10 02:33:14 +00:00
| Volume | Function |
2020-04-28 15:23:37 +00:00
| :---: | :--- |
2019-06-10 02:33:14 +00:00
| `/config` | CodiMD config and configurable files |
## User / Group Identifiers
2020-04-28 15:23:37 +00:00
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` .
2019-06-10 02:33:14 +00:00
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:
2020-04-28 15:23:37 +00:00
```text
2019-06-10 02:33:14 +00:00
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Application Setup
2020-04-28 15:23:37 +00:00
CodiMD web interface can be accessed `http://${IP}:3000/` , if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: \(specifically for CMD\_DOMAIN and CMD\_URL\_ADDPORT\)
2019-06-10 02:33:14 +00:00
2019-06-10 22:19:16 +00:00
[Full list of CodiMD options ](https://github.com/codimd/server/blob/master/docs/configuration-env-vars.md )
2019-06-10 02:33:14 +00:00
For convience we provide a working example using Mysql as a backend in this document, if you do not wish to use our custom environment values or a Mysql database backend feel free to leverage any of the settings laid out in the link above.
2019-06-10 22:19:16 +00:00
To run behind a reverse proxy we have a [preconfigured config ](https://github.com/linuxserver/reverse-proxy-confs/blob/master/codimd.subdomain.conf.sample ) using docker networking included in our [LetsEncrypt ](https://github.com/linuxserver/docker-letsencrypt ) image and you can read how to use this in the [Reverse Proxy Confs repository ](https://github.com/linuxserver/reverse-proxy-confs/#how-to-use-these-reverse-proxy-configs )
2019-06-10 02:33:14 +00:00
2020-04-08 05:09:01 +00:00
## Docker Mods
2020-04-28 15:23:37 +00:00
[![Docker Mods ](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27codimd%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml )](https://mods.linuxserver.io/?mod=codimd)
2020-04-08 05:09:01 +00:00
2020-04-28 15:23:37 +00:00
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\) can be accessed via the dynamic badge above.
2019-10-02 05:09:41 +00:00
2019-06-10 02:33:14 +00:00
## Support Info
2019-09-04 05:09:45 +00:00
* Shell access whilst the container is running:
2019-06-10 02:33:14 +00:00
* `docker exec -it codimd /bin/bash`
2019-09-04 05:09:45 +00:00
* To monitor the logs of the container in realtime:
2019-06-10 02:33:14 +00:00
* `docker logs -f codimd`
2019-09-04 05:09:45 +00:00
* Container version number
2019-06-10 02:33:14 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' codimd`
* Image version number
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/codimd`
## Versions
* **23.05.19:** - Initial release
2020-04-28 15:23:37 +00:00