docker-cloud9/README.md

247 wiersze
14 KiB
Markdown
Czysty Zwykły widok Historia

2020-10-07 00:02:15 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the CONTRIBUTING.md -->
2019-06-04 02:19:18 +00:00
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
2020-06-02 20:02:14 +00:00
[![Blog](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Blog)](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
[![Discord](https://img.shields.io/discord/354974912613449730.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Discord&logo=discord)](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
[![Discourse](https://img.shields.io/discourse/https/discourse.linuxserver.io/topics.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=discourse)](https://discourse.linuxserver.io "post on our community forum.")
[![Fleet](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Fleet)](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
[![GitHub](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub&logo=github)](https://github.com/linuxserver "view the source for all of our repositories.")
[![Open Collective](https://img.shields.io/opencollective/all/linuxserver.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=Supporters&logo=open%20collective)](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
2019-09-04 19:02:04 +00:00
2020-04-08 07:55:52 +00:00
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
2019-06-04 02:19:18 +00:00
* 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:
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
2019-09-04 19:02:04 +00:00
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
2019-11-06 08:55:54 +00:00
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
2019-09-04 19:02:04 +00:00
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
2019-06-04 02:19:18 +00:00
# [linuxserver/cloud9](https://github.com/linuxserver/docker-cloud9)
2019-11-06 08:55:54 +00:00
2020-06-02 20:02:14 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-cloud9.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-cloud9)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-cloud9.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-cloud9/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-cloud9/packages)
2020-12-16 20:12:25 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-cloud9/container_registry)
2020-06-02 20:02:14 +00:00
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/cloud9.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/cloud9 "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/cloud9.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/cloud9)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/cloud9.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/cloud9)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-cloud9%2Fjob%2Fnodejs%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-cloud9/job/nodejs/)
2020-11-02 04:45:57 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fcloud9%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/cloud9/latest/index.html)
2019-06-04 02:19:18 +00:00
[Cloud9](https://github.com/c9/core) Cloud9 is a complete web based IDE with terminal access. This container is for running their core SDK locally and developing plugins.
[![cloud9](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/cloud9.png)](https://github.com/c9/core)
## Supported Architectures
2019-09-04 19:02:04 +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-04 02:19:18 +00:00
2020-11-02 04:45:57 +00:00
Simply pulling `ghcr.io/linuxserver/cloud9` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
2019-06-04 02:19:18 +00:00
The architectures supported by this image are:
| Architecture | Tag |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
## Version Tags
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
| :----: | --- |
| latest | Docker and Compose environment pre-installed |
| go | Basic Golang environment pre-installed |
| nodejs | Current stable NodeJS/NPM environment pre-installed |
| python | Current Python3 environment pre-installed |
| ruby | Current Ruby environment pre-installed |
## Usage
Here are some example snippets to help you get started creating a container.
2020-10-07 00:02:15 +00:00
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
2019-06-04 02:19:18 +00:00
Compatible with docker-compose v2 schemas.
2020-10-07 00:02:15 +00:00
```yaml
2019-06-04 02:19:18 +00:00
---
2020-04-08 07:55:52 +00:00
version: "2.1"
2019-06-04 02:19:18 +00:00
services:
cloud9:
2020-11-02 04:45:57 +00:00
image: ghcr.io/linuxserver/cloud9
2019-06-04 02:19:18 +00:00
container_name: cloud9
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
- GITURL=https://github.com/linuxserver/docker-cloud9.git #optional
2020-02-07 23:08:37 +00:00
- USERNAME= #optional
- PASSWORD= #optional
2019-06-04 02:19:18 +00:00
volumes:
2020-02-07 23:08:37 +00:00
- /path/to/your/code:/code #optional
2019-06-04 02:19:18 +00:00
- /var/run/docker.sock:/var/run/docker.sock #optional
ports:
- 8000:8000
restart: unless-stopped
```
2020-10-07 00:02:15 +00:00
### docker cli
```
docker run -d \
--name=cloud9 \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-e GITURL=https://github.com/linuxserver/docker-cloud9.git `#optional` \
-e USERNAME= `#optional` \
-e PASSWORD= `#optional` \
-p 8000:8000 \
-v /path/to/your/code:/code `#optional` \
-v /var/run/docker.sock:/var/run/docker.sock `#optional` \
--restart unless-stopped \
2020-11-02 04:45:57 +00:00
ghcr.io/linuxserver/cloud9
2020-10-07 00:02:15 +00:00
```
2019-06-04 02:19:18 +00:00
## Parameters
Container 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 |
| :----: | --- |
| `-p 8000` | The port for the Cloud9 web interface |
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
2020-02-07 23:08:37 +00:00
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London |
2019-06-04 02:19:18 +00:00
| `-e GITURL=https://github.com/linuxserver/docker-cloud9.git` | Specify a git repo to checkout on first startup |
2020-02-07 23:08:37 +00:00
| `-e USERNAME=` | Optionally specify a username for http auth |
| `-e PASSWORD=` | Optionally specify a password for http auth (if USERNAME and PASSWORD are not set, there will be no http auth) |
2019-06-04 02:19:18 +00:00
| `-v /code` | Optionally if you want to mount up a local folder of code instead of checking out |
| `-v /var/run/docker.sock` | Needed if you plan to use Docker or compose commands |
2019-12-04 08:56:01 +00:00
## Environment variables from files (Docker secrets)
2020-06-02 20:02:14 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
2019-12-04 08:56:01 +00:00
As an example:
```
-e FILE__PASSWORD=/run/secrets/mysecretpassword
```
Will set the environment variable `PASSWORD` based on the contents of the `/run/secrets/mysecretpassword` file.
2020-06-02 20:02:14 +00:00
## Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-06-04 02:19:18 +00:00
## 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=1000` and `PGID=1000`, to find yours use `id user` as below:
```
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
&nbsp;
## Application Setup
Access the webui at http://your-ip:8000, for more information check out [here](https://docs.c9.io/docs).
2020-04-08 07:55:52 +00:00
## Docker Mods
2020-10-07 00:02:15 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=cloud9&query=%24.mods%5B%27cloud9%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=cloud9 "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.")
2020-04-08 07:55:52 +00:00
2020-10-07 00:02:15 +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) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-08 07:55:52 +00:00
2019-06-04 02:19:18 +00:00
## Support Info
* Shell access whilst the container is running: `docker exec -it cloud9 /bin/bash`
* To monitor the logs of the container in realtime: `docker logs -f cloud9`
2019-09-04 19:02:04 +00:00
* container version number
2019-06-04 02:19:18 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' cloud9`
* image version number
2020-11-02 04:45:57 +00:00
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' ghcr.io/linuxserver/cloud9`
2019-06-04 02:19:18 +00:00
## Updating Info
2019-09-04 19:02:04 +00:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers:
2019-06-04 02:19:18 +00:00
### Via Docker Compose
* Update all images: `docker-compose pull`
* or update a single image: `docker-compose pull cloud9`
* Let compose update all containers as necessary: `docker-compose up -d`
* or update a single container: `docker-compose up -d cloud9`
* You can also remove the old dangling images: `docker image prune`
2020-10-07 00:02:15 +00:00
### Via Docker Run
2020-11-02 04:45:57 +00:00
* Update the image: `docker pull ghcr.io/linuxserver/cloud9`
2020-10-07 00:02:15 +00:00
* Stop the running container: `docker stop cloud9`
* Delete the container: `docker rm cloud9`
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images: `docker image prune`
### Via Watchtower auto-updater (only use if you don't remember the original parameters)
2019-06-04 02:19:18 +00:00
* Pull the latest image at its tag and replace it with the same env variables in one run:
```
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once cloud9
```
2020-10-07 00:02:15 +00:00
* You can also remove the old dangling images: `docker image prune`
2019-07-03 19:02:03 +00:00
2020-10-07 00:02:15 +00:00
**Note:** We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
2019-07-03 19:02:03 +00:00
2020-10-07 00:02:15 +00:00
### Image Update Notifications - Diun (Docker Image Update Notifier)
* We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
2019-06-04 02:19:18 +00:00
## Building locally
2019-09-04 19:02:04 +00:00
If you want to make local modifications to these images for development purposes or just to customize the logic:
2019-06-04 02:19:18 +00:00
```
git clone https://github.com/linuxserver/docker-cloud9.git
cd docker-cloud9
docker build \
--no-cache \
--pull \
2020-11-02 04:45:57 +00:00
-t ghcr.io/linuxserver/cloud9:latest .
2019-06-04 02:19:18 +00:00
```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
```
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
## Versions
2020-02-07 23:08:37 +00:00
* **07.02.20:** - Add optional http auth.
2019-06-04 02:19:18 +00:00
* **02.06.19:** - Initial Release.