From 5142519eb9c68cb01aa833ad4b07702f1c19a4ff Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Wed, 7 Oct 2020 05:09:22 +0000 Subject: [PATCH] Bot Updating Documentation --- images/docker-codimd.md | 46 ++++++++++++++++++++--------------------- 1 file changed, 23 insertions(+), 23 deletions(-) diff --git a/images/docker-codimd.md b/images/docker-codimd.md index da7080268..5ac2ecda5 100644 --- a/images/docker-codimd.md +++ b/images/docker-codimd.md @@ -34,27 +34,7 @@ The architectures supported by this image are: Here are some example snippets to help you get started creating a container from this image. -### docker - -``` -docker create \ - --name=codimd \ - -e PUID=1000 \ - -e PGID=1000 \ - -e DB_HOST= \ - -e DB_PORT=3306 \ - -e DB_USER=codimd \ - -e DB_PASS= \ - -e DB_NAME=codimd \ - -e TZ=Europe/London \ - -p 3000:3000 \ - -v :/config \ - --restart unless-stopped \ - linuxserver/codimd -``` - - -### docker-compose +### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose)) Compatible with docker-compose v2 schemas. @@ -97,6 +77,26 @@ services: ``` +### docker cli + +``` +docker run -d \ + --name=codimd \ + -e PUID=1000 \ + -e PGID=1000 \ + -e DB_HOST= \ + -e DB_PORT=3306 \ + -e DB_USER=codimd \ + -e DB_PASS= \ + -e DB_NAME=codimd \ + -e TZ=Europe/London \ + -p 3000:3000 \ + -v :/config \ + --restart unless-stopped \ + linuxserver/codimd +``` + + ## Parameters Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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. @@ -172,9 +172,9 @@ To run behind a reverse proxy we have a [preconfigured config](https://github.co ## Docker Mods -[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&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 "view available mods for this container.") +[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=codimd&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 "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.") -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. +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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above. ## Support Info