From 7099d80389f20f6cd71ba3582fe4f3309daecdab Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Thu, 21 Feb 2019 23:11:20 +0000 Subject: [PATCH] Bot Updating Templated Files --- images/docker-taisun.md | 115 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 115 insertions(+) create mode 100755 images/docker-taisun.md diff --git a/images/docker-taisun.md b/images/docker-taisun.md new file mode 100755 index 0000000000..120e1c803d --- /dev/null +++ b/images/docker-taisun.md @@ -0,0 +1,115 @@ +# [linuxserver/taisun](https://github.com/linuxserver/docker-taisun) + +[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn) +[![](https://images.microbadger.com/badges/version/linuxserver/taisun.svg)](https://microbadger.com/images/linuxserver/taisun "Get your own version badge on microbadger.com") +[![](https://images.microbadger.com/badges/image/linuxserver/taisun.svg)](https://microbadger.com/images/linuxserver/taisun "Get your own version badge on microbadger.com") +![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/taisun.svg) +![Docker Stars](https://img.shields.io/docker/stars/linuxserver/taisun.svg) +[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-taisun/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-taisun/job/master/) +[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/taisun/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/taisun/latest/index.html) + +[Taisun](https://www.taisun.io/) is an application for a Docker enabled device with an emphasis on providing a web based interface for managing a single server. +Taisun allows you to: + + - Deploy and manage web based virtual desktops. + - Deploy Taisun specific stacks of applications + - Browse available images on popular Docker repositories + - Import a Docker project from any git repository and start developing on your choice of web based IDE or full Linux desktop + - Spinup a developer container based on popular frameworks and work from a web based IDE + - Single click remote server access to Taisun and your Docker applications + + +## Supported Architectures + +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). + +Simply pulling `linuxserver/taisun` should retrieve the correct image for your arch, but you can also pull specific arch images via tags. + +The architectures supported by this image are: + +| Architecture | Tag | +| :----: | --- | +| x86-64 | amd64-latest | +| arm64 | arm64v8-latest | +| armhf | arm32v6-latest | + + +## Usage + +Here are some example snippets to help you get started creating a container from this image. + +### docker + +``` +docker create \ + --name=taisun \ + -p 3000:3000 \ + -v /var/run/docker.sock:/var/run/docker.sock \ + --restart unless-stopped \ + linuxserver/taisun +``` + + +### docker-compose + +Compatible with docker-compose v2 schemas. + +```yaml +--- +version: "2" +services: + taisun: + image: linuxserver/taisun + container_name: taisun + volumes: + - /var/run/docker.sock:/var/run/docker.sock + ports: + - 3000:3000 + mem_limit: 4096m + restart: unless-stopped +``` + +## 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. + +### Ports (`-p`) + +| Parameter | Function | +| :----: | --- | +| `3000` | Taisun WebUI. | + + +### Environment Variables (`-e`) + +| Env | Function | +| :----: | --- | + +### Volume Mappings (`-v`) + +| Volume | Function | +| :----: | --- | +| `/var/run/docker.sock` | Docker Socket on the system | + + + +## Application Setup + +The webui is at http://localhost:3000, for more information on usage see [here](https://github.com/Taisun-Docker/taisun/wiki/Usage). + + + +## Support Info + +* Shell access whilst the container is running: + * `docker exec -it taisun /bin/bash` +* To monitor the logs of the container in realtime: + * `docker logs -f taisun` +* Container version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' taisun` +* Image version number + * `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/taisun` + +## Versions + +* **13.02.19:** - Initial release.