diff --git a/README.md b/README.md index 9a3f8478cd47599b931f955159e75c7333a39fcc..eb8d2fcf5be4169eee75169bac687143d2530853 100644 --- a/README.md +++ b/README.md @@ -1,38 +1,104 @@ -# ICEcoder-Container -https://github.com/icecoder/ICEcoder in a container! +[](https://github.com/icecoder/ICEcoder) - - - - - - +[](https://hub.docker.com/repository/docker/griefed/icecoder) +[](https://hub.docker.com/repository/docker/griefed/icecoder) +[](https://hub.docker.com/repository/docker/griefed/icecoder) +[](https://hub.docker.com/repository/docker/griefed/icecoder) +[](https://github.com/Griefed/docker-ICEcoder) +[](https://github.com/Griefed/docker-ICEcoder) -Creates a Container which runs [icecoder's](https://github.com/icecoder) [ICEcoder](https://github.com/icecoder/ICEcoder) with, [php:alpine](https://hub.docker.com/_/php) as the base image, as seen on https://icecoder.net/ +ICEcoder is a browser based code editor, which provides a modern approach to building websites. By allowing you to code directly within the web browser, online or offline, it means you only need one program (your browser) to develop sites, plus can test on actual web servers. After development, you can also maintain the website easily, all of which make for speedy and smart development. +--- -# Deploy with docker-compose: -``` +Creates a Container which runs [icecoder's](https://github.com/icecoder) [ICEcoder](https://github.com/icecoder/ICEcoder), with [lsiobase/alpine](https://hub.docker.com/r/lsiobase/alpine) as the base image, as seen on https://icecoder.net/. + +The lasiobase/alpine image is a custom base image built with [Alpine linux](https://alpinelinux.org/) and [S6 overlay](https://github.com/just-containers/s6-overlay). +Using this image allows us to use the same user/group ids in the container as on the host, making file transfers much easier + +## Deployment + +### Pre-built images + +```docker-compose.yml +version: '3.6' +services: icecoder: container_name: icecoder image: griefed/icecoder restart: unless-stopped + volumes: + - ./icecoder/config:/config + - ./icecoder/data:/data + - ./icecoder/plugins:/plugins + environment: + - GITURL=https://github.com/icecoder/ICEcoder.git + - PUID=1000 + - PGID=1000 + - TZ=Europe/Berlin ports: - 8080:8080 ``` -### Deploy on Rasbperry Pi -Using the Dockerfile, this container can be built and run on a Raspberry Pi, too! I've tested it on a Raspberry Pi 3B+. -Simply put the Dockerfile in a directory called `ICEcoder` in the same directory as your docker-compose.yml, edit your docker-compose.yml: + +## Configuration + +Configuration | Explanation +------------ | ------------- +restart | [Restart policy](https://docs.docker.com/compose/compose-file/#restart) Either: "no", always, on-failure, unless-stopped +volumes | /config contains all relevant configuration files. +volumes | /data contains all relevant data like code. /data/code is the directory where GITURL is cloned into, for example. +volumes | /plugins contains all plugin files. +GITURL | Specify a GitHub repository to checkout on first run of the container. +TZ | Timezone +PUID | for UserID +PGID | for GroupID +ports | The port where the service will be available at. + +## User / Group Identifiers + +When using volumes, permissions issues can arise between the host OS and the container. [Linuxserver.io](https://www.linuxserver.io/) avoids 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) ``` + +### Raspberry Pi & building the image yourself + +Using the [Dockerfile](https://github.com/Griefed/docker-ICEcoder/blob/lsiobase/alpine/Dockerfile), this container can be built and run on a Raspberry Pi. +I've tested it on a Raspberry Pi 3B. + +#### docker-compose.yml + +```docker-compose.yml +version: '3.6' +services: icecoder: container_name: icecoder - build: ./ICEcoder/ + build: ./icecoder/ restart: unless-stopped + volumes: + - ./icecoder/config:/config + - ./icecoder/data:/data + - ./icecoder/plugins:/plugins + environment: + - GITURL=https://github.com/icecoder/ICEcoder.git + - PUID=1000 + - PGID=1000 + - TZ=Europe/Berlin ports: - 8080:8080 ``` -Then build with: -``` -docker-compose up -d --build icecoder -``` + +1. Clone the repository: `git clone https://github.com/Griefed/docker-ICEcoder.git ./icecoder` +1. Prepare docker-compose.yml file as seen above +1. `docker-compose up -d --build icecoder` +1. Visit IP.ADDRESS.OF.HOST:8080 +1. ??? +1. Profit! + 