2024-04-29 11:49:45 +00:00
<!doctype html> < html lang = en class = no-js > < head > < meta charset = utf-8 > < meta name = viewport content = "width=device-width,initial-scale=1" > < meta name = description content = "Welcome to the home of the LinuxServer.io documentation!" > < meta name = author content = LinuxServer.io > < link href = https://docs.linuxserver.io/deprecated_images/docker-codiad/ rel = canonical > < link href = ../docker-cloud9/ rel = prev > < link href = ../docker-codimd/ rel = next > < link rel = icon href = ../../assets/favicon.ico > < meta name = generator content = "mkdocs-1.6.0, mkdocs-material-9.5.19" > < title > codiad - LinuxServer.io< / title > < link rel = stylesheet href = ../../assets/stylesheets/main.66ac8b77.min.css > < link rel = stylesheet href = ../../assets/stylesheets/palette.06af60db.min.css > < link rel = preconnect href = https://fonts.gstatic.com crossorigin > < link rel = stylesheet href = "https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback" > < style > : root { --md-text-font : "Roboto" ; --md-code-font : "Roboto Mono" } < / style > < script > _ _md _scope = new URL ( "../.." , location ) , _ _md _hash = e => [ ... e ] . reduce ( ( e , _ ) => ( e << 5 ) - e + _ . charCodeAt ( 0 ) , 0 ) , _ _md _get = ( e , _ = localStorage , t = _ _md _scope ) => JSON . parse ( _ . getItem ( t . pathname + "." + e ) ) , _ _md _set = ( e , _ , t = localStorage , a = _ _md _scope ) => { try { t . setItem ( a . pathname + "." + e , JSON . stringify ( _ ) ) } catch ( e ) { } } < / script > < / head > < body dir = ltr data-md-color-scheme = default data-md-color-primary = purple data-md-color-accent = indigo > < input class = md-toggle data-md-toggle = drawer type = checkbox id = __drawer autocomplete = off > < input class = md-toggle data-md-toggle = search type = checkbox id = __search autocomplete = off > < label class = md-overlay for = __drawer > < / label > < div data-md-component = skip > < a href = #deprecation-notice class = md-skip > Skip to content < / a > < / div > < div data-md-component = announce > < / div > < header class = md-header data-md-component = header > < nav class = "md-header__inner md-grid" aria-label = Header > < a href = ../.. title = LinuxServer.io class = "md-header__button md-logo" aria-label = LinuxServer.io data-md-component = logo > < img src = ../../assets/icon.svg alt = logo > < / a > < label class = "md-header__button md-icon" for = __drawer > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M3 6h18v2H3V6m0 5h18v2H3v-2m0 5h18v2H3v-2Z" / > < / svg > < / label > < div class = md-header__title data-md-component = header-title > < div class = md-header__ellipsis > < div class = md-header__topic > < span class = md-ellipsis > LinuxServer.io < / span > < / div > < div class = md-header__topic data-md-component = header-topic > < span class = md-ellipsis > codiad < / span > < / div > < / div > < / div > < form class = md-header__option data-md-component = palette > < input class = md-option data-md-color-media = "(prefers-color-scheme: light)" data-md-color-scheme = default data-md-color-primary = purple data-md-color-accent = indigo aria-label = "Switch to dark mode" type = radio name = __palette id = __palette_0 > < label class = "md-header__button md-icon" title = "Switch to dark mode" for = __palette_1 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z" / > < / svg > < / label > < input class = md-option data-md-color-media = "(prefers-color-scheme: dark)" data-md-color-scheme = slate data-md-color-primary = purple data-md-color-accent = indigo aria-label = "Switch to light mode" type = radio name = __palette id = __palette_1 > < label class = "md-header__button md-icon" title = "Switch to light mode" for = __palette_0 hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12c0-2.42-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12 20 8.69Z" / > < / svg > < / label > < / form > < script > v a r m e d i a , i n p u t , k e y , v a l u e , p a l e t t e = _ _ m d _ g e t ( " _ _ p a l e t t e " ) ; i f ( p a l e t t e & & p a l e t t e . c o l o r ) { " ( p r e f e r s - c o l o r - s c h e m e ) " = = = p a l e t t e . c o l o r . m e d i a & & ( m e d i a = m a t c h M e d i a ( " ( p r e f e r s - c o l o r - s c h e m e : l i g h t ) " ) , i n p u t =
2023-10-14 23:57:57 +00:00
< / span > < span id = __span-0-2 > < a id = __codelineno-0-2 name = __codelineno-0-2 href = #__codelineno-0-2 > < / a > --name=codiad \
< / span > < span id = __span-0-3 > < a id = __codelineno-0-3 name = __codelineno-0-3 href = #__codelineno-0-3 > < / a > -e PUID=1000 \
< / span > < span id = __span-0-4 > < a id = __codelineno-0-4 name = __codelineno-0-4 href = #__codelineno-0-4 > < / a > -e PGID=1000 \
< / span > < span id = __span-0-5 > < a id = __codelineno-0-5 name = __codelineno-0-5 href = #__codelineno-0-5 > < / a > -e TZ=Europe/London \
< / span > < span id = __span-0-6 > < a id = __codelineno-0-6 name = __codelineno-0-6 href = #__codelineno-0-6 > < / a > -p 80:80 \
< / span > < span id = __span-0-7 > < a id = __codelineno-0-7 name = __codelineno-0-7 href = #__codelineno-0-7 > < / a > -v < path to data> :/config \
< / span > < span id = __span-0-8 > < a id = __codelineno-0-8 name = __codelineno-0-8 href = #__codelineno-0-8 > < / a > --restart unless-stopped \
< / span > < span id = __span-0-9 > < a id = __codelineno-0-9 name = __codelineno-0-9 href = #__codelineno-0-9 > < / a > linuxserver/codiad
< / span > < / code > < / pre > < / div > < h3 id = docker-compose > docker-compose< a class = headerlink href = #docker-compose title = "Permanent link" > ¶ < / a > < / h3 > < p > Compatible with docker-compose v2 schemas.< / p > < div class = "language-yaml highlight" > < pre > < span > < / span > < code > < span id = __span-1-1 > < a id = __codelineno-1-1 name = __codelineno-1-1 href = #__codelineno-1-1 > < / a > < span class = nn > ---< / span >
< / span > < span id = __span-1-2 > < a id = __codelineno-1-2 name = __codelineno-1-2 href = #__codelineno-1-2 > < / a > < span class = nt > version< / span > < span class = p > :< / span > < span class = w > < / span > < span class = s > " 2" < / span >
< / span > < span id = __span-1-3 > < a id = __codelineno-1-3 name = __codelineno-1-3 href = #__codelineno-1-3 > < / a > < span class = nt > services< / span > < span class = p > :< / span >
< / span > < span id = __span-1-4 > < a id = __codelineno-1-4 name = __codelineno-1-4 href = #__codelineno-1-4 > < / a > < span class = w > < / span > < span class = nt > codiad< / span > < span class = p > :< / span >
< / span > < span id = __span-1-5 > < a id = __codelineno-1-5 name = __codelineno-1-5 href = #__codelineno-1-5 > < / a > < span class = w > < / span > < span class = nt > image< / span > < span class = p > :< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > linuxserver/codiad< / span >
< / span > < span id = __span-1-6 > < a id = __codelineno-1-6 name = __codelineno-1-6 href = #__codelineno-1-6 > < / a > < span class = w > < / span > < span class = nt > container_name< / span > < span class = p > :< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > codiad< / span >
< / span > < span id = __span-1-7 > < a id = __codelineno-1-7 name = __codelineno-1-7 href = #__codelineno-1-7 > < / a > < span class = w > < / span > < span class = nt > environment< / span > < span class = p > :< / span >
< / span > < span id = __span-1-8 > < a id = __codelineno-1-8 name = __codelineno-1-8 href = #__codelineno-1-8 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > PUID=1000< / span >
< / span > < span id = __span-1-9 > < a id = __codelineno-1-9 name = __codelineno-1-9 href = #__codelineno-1-9 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > PGID=1000< / span >
< / span > < span id = __span-1-10 > < a id = __codelineno-1-10 name = __codelineno-1-10 href = #__codelineno-1-10 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > TZ=Europe/London< / span >
< / span > < span id = __span-1-11 > < a id = __codelineno-1-11 name = __codelineno-1-11 href = #__codelineno-1-11 > < / a > < span class = w > < / span > < span class = nt > volumes< / span > < span class = p > :< / span >
< / span > < span id = __span-1-12 > < a id = __codelineno-1-12 name = __codelineno-1-12 href = #__codelineno-1-12 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > < path to data> :/config< / span >
< / span > < span id = __span-1-13 > < a id = __codelineno-1-13 name = __codelineno-1-13 href = #__codelineno-1-13 > < / a > < span class = w > < / span > < span class = nt > ports< / span > < span class = p > :< / span >
< / span > < span id = __span-1-14 > < a id = __codelineno-1-14 name = __codelineno-1-14 href = #__codelineno-1-14 > < / a > < span class = w > < / span > < span class = "p p-Indicator" > -< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > 80:80< / span >
< / span > < span id = __span-1-15 > < a id = __codelineno-1-15 name = __codelineno-1-15 href = #__codelineno-1-15 > < / a > < span class = w > < / span > < span class = nt > restart< / span > < span class = p > :< / span > < span class = w > < / span > < span class = "l l-Scalar l-Scalar-Plain" > unless-stopped< / span >
< / span > < / code > < / pre > < / div > < h2 id = parameters > Parameters< a class = headerlink href = #parameters title = "Permanent link" > ¶ < / a > < / h2 > < p > Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate < code > < external> :< internal> < / code > respectively. For example, < code > -p 8080:80< / code > would expose port < code > 80< / code > from inside the container to be accessible from the host's IP on port < code > 8080< / code > outside the container.< / p > < h3 id = ports-p > Ports (< code > -p< / code > )< a class = headerlink href = #ports-p title = "Permanent link" > ¶ < / a > < / h3 > < table > < thead > < tr > < th style = "text-align: center;" > Parameter< / th > < th style = "text-align: left;" > Function< / th > < / tr > < / thead > < tbody > < tr > < td style = "text-align: center;" > < code > 80< / code > < / td > < td style = "text-align: left;" > WebUI< / td > < / tr > < / tbody > < / table > < h3 id = environment-variables-e > Environment Variables (< code > -e< / code > )< a class = headerlink href = #environment-variables-e title = "Permanent link" > ¶ < / a > < / h3 > < table > < thead > < tr > < th style = "text-align: center;" > Env< / th > < th style = "text-align: left;" > Function< / th > < / tr > < / thead > < tbody > < tr > < td style = "text-align: center;" > < code > PUID=1000< / code > < / td > < td style = "text-align: left;" > for UserID - see below for explanation< / td > < / tr > < tr > < td style = "text-align: center;" > < code > PGID=1000< / code > < / td > < td style = "text-align: left;" > for GroupID - see below for explanation< / td > < / tr > < tr > < td style = "text-align: center;" > < code > TZ=Europe/London< / code > < / td > < td style = "text-align: left;" > Specify a timezone to use EG Europe/London.< / td > < / tr > < / tbody > < / table > < h3 id = volume-mappings-v > Volume Mappings (< code > -v< / code > )< a class = headerlink href = #volume-mappings-v title = "Permanent link" > ¶ < / a > < / h3 > < table > < thead > < tr > < th style = "text-align: center;" > Volume< / th > < th style = "text-align: left;" > Function< / th > < / tr > < / thead > < tbody > < tr > < td style = "text-align: center;" > < code > /config< / code > < / td > < td style = "text-align: left;" > Where Codiad stores data.< / td > < / tr > < / tbody > < / table > < h2 id = user-group-identifiers > User / Group Identifiers< a class = headerlink href = #user-group-identifiers title = "Permanent link" > ¶ < / a > < / h2 > < p > When using volumes (< code > -v< / code > flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user < code > PUID< / code > and group < code > PGID< / code > .< / p > < p > Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.< / p > < p > In this instance < code > PUID=1000< / code > and < code > PGID=1000< / code > , to find yours use < code > id user< / code > as below:< / p > < div class = "language-text highlight" > < pre > < span > < / span > < code > < span id = __span-2-1 > < a id = __codelineno-2-1 name = __codelineno-2-1 href = #__codelineno-2-1 > < / a > $ id username
< / span > < span id = __span-2-2 > < a id = __codelineno-2-2 name = __codelineno-2-2 href = #__codelineno-2-2 > < / a > uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
2024-04-29 11:49:45 +00:00
< / span > < / code > < / pre > < / div > < h2 id = support-info > Support Info< a class = headerlink href = #support-info title = "Permanent link" > ¶ < / a > < / h2 > < ul > < li > Shell access whilst the container is running: < / li > < li > < code > docker exec -it codiad /bin/bash< / code > < / li > < li > To monitor the logs of the container in realtime: < / li > < li > < code > docker logs -f codiad< / code > < / li > < li > Container version number < / li > < li > < code > docker inspect -f '{{ index .Config.Labels "build_version" }}' codiad< / code > < / li > < li > Image version number< / li > < li > < code > docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/codiad< / code > < / li > < / ul > < h2 id = versions > Versions< a class = headerlink href = #versions title = "Permanent link" > ¶ < / a > < / h2 > < ul > < li > < strong > 10.06.19:< / strong > - Deprecate Image.< / li > < li > < strong > 23.03.19:< / strong > - Switching to new Base images, shift to arm32v7 tag.< / li > < li > < strong > 22.02.19:< / strong > - Rebasing to alpine 3.9, adding ssh client.< / li > < li > < strong > 16.01.19:< / strong > - Add pipeline logic and multi arch.< / li > < li > < strong > 26.09.18:< / strong > - Add sed to init file to configure projects folder correctly.< / li > < li > < strong > 04.09.18:< / strong > - Rebase to alpine linux 3.8.< / li > < li > < strong > 09.01.18:< / strong > - Rebase to alpine linux 3.7.< / li > < li > < strong > 25.05.17:< / strong > - Rebase to alpine linux 3.6.< / li > < li > < strong > 18.02.17:< / strong > - Rebase to alpine linux 3.5.< / li > < li > < strong > 14.10.16:< / strong > - Add version layer information.< / li > < li > < strong > 10.09.16:< / strong > - Add layer badges to README.< / li > < li > < strong > 06.11.15:< / strong > - Initial Release.< / li > < / ul > < aside class = md-source-file > < span class = md-source-file__fact > < span class = md-icon title = "Last update" > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1-2.1-2M12.5 7v5.2l4 2.4-1 1L11 13V7h1.5M11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2v1.8Z" / > < / svg > < / span > < span class = "git-revision-date-localized-plugin git-revision-date-localized-plugin-date" > October 14, 2023< / span > < / span > < span class = md-source-file__fact > < span class = md-icon title = Created > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M14.47 15.08 11 13V7h1.5v5.25l3.08 1.83c-.41.28-.79.62-1.11 1m-1.39 4.84c-.36.05-.71.08-1.08.08-4.42 0-8-3.58-8-8s3.58-8 8-8 8 3.58 8 8c0 .37-.03.72-.08 1.08.69.1 1.33.32 1.92.64.1-.56.16-1.13.16-1.72 0-5.5-4.5-10-10-10S2 6.5 2 12s4.47 10 10 10c.59 0 1.16-.06 1.72-.16-.32-.59-.54-1.23-.64-1.92M18 15v3h-3v2h3v3h2v-3h3v-2h-3v-3h-2Z" / > < / svg > < / span > < span class = "git-revision-date-localized-plugin git-revision-date-localized-plugin-date" > February 5, 2019< / span > < / span > < / aside > < / article > < / div > < script > var target = document . getElementById ( location . hash . slice ( 1 ) ) ; target && target . name && ( target . checked = target . name . startsWith ( "__tabbed_" ) ) < / script > < / div > < button type = button class = "md-top md-icon" data-md-component = top hidden > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8v12Z" / > < / svg > Back to top < / button > < / main > < footer class = md-footer > < nav class = "md-footer__inner md-grid" aria-label = Footer > < a href = ../docker-cloud9/ class = "md-footer__link md-footer__link--prev" aria-label = "Previous: cloud9" > < div class = "md-footer__button md-icon" > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11h12Z" / > < / svg > < / div > < div class = md-footer__title > < span class = md-footer__direction > Previous < / span > < div class = md-ellipsis > cloud9 < / div > < / div > < / a > < a href = ../docker-codimd/ class = "md-footer__link md-footer__link--next" aria-label = "Next: codimd" > < div class = md-footer__title > < span class = md-footer__direction > Next < / span > < div class = md-ellipsis > codimd < / div > < / div > < div class = "md-footer__button md-icon" > < svg xmlns = http://www.w3.org/2000/svg viewbox = "0 0 24 24" > < path d = "M4 11v2h12l-5 .
