​​​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​​
​Codimd gives you access to all your files wherever you are.
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.
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 and our announcement here.
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 |
x86-64 | amd64-latest |
arm64 | arm64v8-latest |
armhf | arm32v7-latest |
Here are some example snippets to help you get started creating a container from this image.
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
Compatible with docker-compose v2 schemas.
version: "3"services:mariadb:image: linuxserver/mariadb:latestcontainer_name: codimd_mariadbrestart: alwaysvolumes:- <path to mariadb data>:/configenvironment:- MYSQL_ROOT_PASSWORD=<secret password>- MYSQL_DATABASE=codimd- MYSQL_USER=codimd- MYSQL_PASSWORD=<secret password>- PGID=1000- PUID=1000- TZ=Europe/Londoncodimd:image: linuxserver/codimd:latestcontainer_name: codimdrestart: alwaysdepends_on:- mariadbvolumes:- <path to config>:/configenvironment:- DB_HOST=mariadb- DB_USER=codimd- DB_PASS=<secret password>- DB_NAME=codimd- DB_PORT=3306- PGID=1000- PUID=1000- TZ=Europe/Londonports:- "3000:3000"
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.
Parameter | Function |
| If you wish to access this container from http://{IP}:${PORT}` this must be left unchanged. |
Env | Function |
| for UserID - see below for explanation |
| for GroupID - see below for explanation |
| Host address of mysql database |
| Port to access mysql database default is 3306 |
| Database user |
| Database password |
| Database name |
| Specify a timezone to use EG Europe/London. |
Volume | Function |
| CodiMD config and configurable files |
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
.
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:
$ id usernameuid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
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)
​Full list of CodiMD options​
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.
To run behind a reverse proxy we have a preconfigured config using docker networking included in our LetsEncrypt image and you can read how to use this in the Reverse Proxy Confs repository​
Shell access whilst the container is running:
docker exec -it codimd /bin/bash
To monitor the logs of the container in realtime:
docker logs -f codimd
Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' codimd
Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/codimd
23.05.19: - Initial release