From b9ada98a482b4657271d8b9c19c2a92d9f323e1c Mon Sep 17 00:00:00 2001 From: IronicBadger Date: Fri, 27 Jul 2018 20:22:03 +0100 Subject: [PATCH] added codiad --- generate-docs.yml | 1 + readme/codiad/README.md | 112 +++++++++++++++++++++ readme/plex/README.md | 4 + readme/smokeping/README.md | 4 + roles/generate-docs/defaults/main.yml | 4 + roles/generate-docs/templates/README.md.j2 | 5 + vars/_container-vars-blank | 3 + vars/container-codiad | 47 +++++++++ 8 files changed, 180 insertions(+) create mode 100644 readme/codiad/README.md create mode 100644 roles/generate-docs/defaults/main.yml create mode 100644 vars/container-codiad diff --git a/generate-docs.yml b/generate-docs.yml index cc7d856..fef6b0f 100644 --- a/generate-docs.yml +++ b/generate-docs.yml @@ -10,5 +10,6 @@ - { role: roles/generate-docs, container_name: "calibre-web" } - { role: roles/generate-docs, container_name: "cardigann" } - { role: roles/generate-docs, container_name: "clarkson" } + - { role: roles/generate-docs, container_name: "codiad" } - { role: roles/generate-docs, container_name: "plex" } - { role: roles/generate-docs, container_name: "smokeping" } \ No newline at end of file diff --git a/readme/codiad/README.md b/readme/codiad/README.md new file mode 100644 index 0000000..ba1434d --- /dev/null +++ b/readme/codiad/README.md @@ -0,0 +1,112 @@ +![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png) + +The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :- + + * regular and timely application updates + * easy user mappings (PGID, PUID) + * custom base image with s6 overlay + * weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth + * regular security updates + +Find us at: +* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team. +* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord. +* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more! +* [Podcast](https://podcast.linuxserver.io) - on hiatus. Coming back soon (late 2018). + +# [linuxserver/codiad](https://github.com/linuxserver/docker-codiad) +[![](https://images.microbadger.com/badges/version/linuxserver/codiad.svg)](https://microbadger.com/images/linuxservercodiad "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/codiad.svg)](https://microbadger.com/images/linuxserver/codiad "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/codiad.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/codiad.svg) + +[Codiad](http://codiad.com/) is a web-based IDE framework with a small footprint and minimal requirements. We have added a few plugins, more can be added in the marketplace in the WebUI. +* [Collaboration](https://github.com/Codiad/Codiad-Collaborative) +* [Terminal](https://github.com/Fluidbyte/Codiad-Terminal) +* [CodeGit](https://github.com/Andr3as/Codiad-CodeGit) +* [Drag and Drop](https://github.com/Andr3as/Codiad-DragDrop) + +![codiad](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/codiad.png) + +## Usage + +Here are some example snippets to help you get started creating a container. + +### docker + +``` +docker create \ + --name=codiad \ + -e PUID=1001 \ + -e PGID=1001 \ + -p 80:80 \ + -v :/config \ + linuxserver/codiad +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +``` +--- +version: "2" +services: + codiad: + image: linuxserver/codiad + container_name: codiad + environment: + - PUID=1001 + - PGID=1001 + volumes: + - :/config + ports: + - 80:80 + mem_limit: 4096m + restart: unless-stopped +``` + +## Parameters + +Container 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. + +| Parameter | Function | +| :----: | --- | +| `-p 80` | Application WebUI | +| `-e PUID=1001` | for UserID - see below for explanation | +| `-e PGID=1001` | for GroupID - see below for explanation | +| `-v /config` | Configuration files. | + +## User / Group Identifiers + +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=1001` and `PGID=1001`, to find yours use `id user` as below: + +``` + $ id username + uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup) +``` + +  + +## Support Info + +* Shell access whilst the container is running: `docker exec -it codiad /bin/bash` +* To monitor the logs of the container in realtime: `docker logs -f codiad` +* container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' codiad` +* image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/codiad` + +## Versions + +* **09.01.18** - Rebase to alpine linux 3.7. +* **25.05.17** - Rebase to alpine linux 3.6. +* **18.02.17** - Rebase to alpine linux 3.5. +* **14.10.16** - Add version layer information. +* **10.09.16** - Add layer badges to README +* **06.11.15** - Initial Release diff --git a/readme/plex/README.md b/readme/plex/README.md index f49ad58..db5b03f 100644 --- a/readme/plex/README.md +++ b/readme/plex/README.md @@ -21,6 +21,10 @@ Find us at: ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/plex.svg) [Plex](https://plex.tv/) organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server. +* [Collaboration](https://github.com/Codiad/Codiad-Collaborative) +* [Terminal](https://github.com/Fluidbyte/Codiad-Terminal) +* [CodeGit](https://github.com/Andr3as/Codiad-CodeGit) +* [Drag and Drop](https://github.com/Andr3as/Codiad-DragDrop) ![plex](http://the-gadgeteer.com/wp-content/uploads/2015/10/plex-logo-e1446990678679.png) diff --git a/readme/smokeping/README.md b/readme/smokeping/README.md index 82b1087..f8ef5e1 100644 --- a/readme/smokeping/README.md +++ b/readme/smokeping/README.md @@ -21,6 +21,10 @@ Find us at: ![Docker Stars](https://img.shields.io/docker/stars/linuxserver/smokeping.svg) [Smokeping](https://oss.oetiker.ch/smokeping/) keeps track of your network latency. For a full example of what this application is capable of visit [UCDavis](http://smokeping.ucdavis.edu/cgi-bin/smokeping.fcgi). +* [Collaboration](https://github.com/Codiad/Codiad-Collaborative) +* [Terminal](https://github.com/Fluidbyte/Codiad-Terminal) +* [CodeGit](https://github.com/Andr3as/Codiad-CodeGit) +* [Drag and Drop](https://github.com/Andr3as/Codiad-DragDrop) ![smokeping](https://camo.githubusercontent.com/e0694ef783e3fd1d74e6776b28822ced01c7cc17/687474703a2f2f6f73732e6f6574696b65722e63682f736d6f6b6570696e672f696e632f736d6f6b6570696e672d6c6f676f2e706e67) diff --git a/roles/generate-docs/defaults/main.yml b/roles/generate-docs/defaults/main.yml new file mode 100644 index 0000000..c8a88cb --- /dev/null +++ b/roles/generate-docs/defaults/main.yml @@ -0,0 +1,4 @@ +--- + +project_blurb_optional_extras_enabled: false +project_blurb_optional_extras: [] \ No newline at end of file diff --git a/roles/generate-docs/templates/README.md.j2 b/roles/generate-docs/templates/README.md.j2 index 7258279..c889cbb 100644 --- a/roles/generate-docs/templates/README.md.j2 +++ b/roles/generate-docs/templates/README.md.j2 @@ -21,6 +21,11 @@ Find us at: ![Docker Stars]({{ lsio_shieldsio_stars_count_url }}/{{ project_name }}.svg) {{ project_blurb }} +{% if project_blurb_optional_extras_enabled %} +{% for item in project_blurb_optional_extras %} +* {{ item }} +{% endfor %} +{% endif %} ![{{ project_name }}]({{ project_logo }}) diff --git a/vars/_container-vars-blank b/vars/_container-vars-blank index 1d743f7..b070989 100644 --- a/vars/_container-vars-blank +++ b/vars/_container-vars-blank @@ -7,6 +7,9 @@ project_logo: "http://www.logo.com/logo.png" project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) short description goes here." project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project-name }}" +project_blurb_optional_extras_enabled: false +project_blurb_optional_extras: [] + # container parameters common_param_env_vars_enabled: true #PGID, PUID, etc param_container_name: "{{ project_name }}" diff --git a/vars/container-codiad b/vars/container-codiad new file mode 100644 index 0000000..e00596c --- /dev/null +++ b/vars/container-codiad @@ -0,0 +1,47 @@ +--- + +# project information +project_name: codiad +project_url: "http://codiad.com/" +project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/codiad.png" +project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) is a web-based IDE framework with a small footprint and minimal requirements. We have added a few plugins, more can be added in the marketplace in the WebUI." +project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}" + +project_blurb_optional_extras_enabled: true +project_blurb_optional_extras: + - "[Collaboration](https://github.com/Codiad/Codiad-Collaborative)" + - "[Terminal](https://github.com/Fluidbyte/Codiad-Terminal)" + - "[CodeGit](https://github.com/Andr3as/Codiad-CodeGit)" + - "[Drag and Drop](https://github.com/Andr3as/Codiad-DragDrop)" + +# container parameters +common_param_env_vars_enabled: true #PGID, PUID, etc +param_container_name: "{{ project_name }}" +param_usage_include_net: false +param_net: "host" +param_net_desc: "Shares host networking with container." +param_usage_include_env: false +param_env_vars: + - { env_var: "VERSION", env_value: "latest", desc: "Supported values are LATEST, PLEXPASS or a specific version number." } +param_usage_include_vols: true +param_volumes: + - { vol_path: "/config", vol_host_path: "", desc: "Configuration files." } +param_usage_include_ports: true +param_ports: + - { external_port: "80", internal_port: "80", port_desc: "Application WebUI" } + +optional_block_1: false +optional_block_1_items: + - "```" + - "include optional stuff" + - "```" + +# changelog + +changelogs: + - { date: "09.01.18", desc: "Rebase to alpine linux 3.7."} + - { date: "25.05.17", desc: "Rebase to alpine linux 3.6."} + - { date: "18.02.17", desc: "Rebase to alpine linux 3.5."} + - { date: "14.10.16", desc: "Add version layer information."} + - { date: "10.09.16", desc: "Add layer badges to README"} + - { date: "06.11.15", desc: "Initial Release"} \ No newline at end of file