Bot Updating Documentation

pull/13/head
LinuxServer-CI 2020-05-02 13:40:01 -04:00
rodzic 46a50705f3
commit e7d60a38ea
1 zmienionych plików z 40 dodań i 23 usunięć

Wyświetl plik

@ -1,15 +1,26 @@
# linuxserver/taisun
# [linuxserver/taisun](https://github.com/linuxserver/docker-taisun)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-taisun.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-taisun) [![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-taisun.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-taisun/releases) [![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-taisun/packages) [![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-taisun/container_registry) [![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/taisun) [![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/taisun.svg?style=flat-square&color=E68523)](https://microbadger.com/images/linuxserver/taisun) [![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/taisun.svg?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/taisun) [![Docker Stars](https://img.shields.io/docker/stars/linuxserver/taisun.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/taisun) [![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-taisun/job/master/badge/icon?style=flat-square)](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)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-taisun.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-taisun)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-taisun.svg?style=flat-square&color=E68523&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-taisun/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitHub%20Package&logo=github&logoColor=FFFFFF)](https://github.com/linuxserver/docker-taisun/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab&logoColor=FFFFFF)](https://gitlab.com/Linuxserver.io/docker-taisun/container_registry)
[![Quay.io](https://img.shields.io/static/v1.svg?style=flat-square&color=E68523&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/taisun)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/taisun.svg?style=flat-square&color=E68523)](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?style=flat-square&color=E68523&label=pulls&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/taisun)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/taisun.svg?style=flat-square&color=E68523&label=stars&logo=docker&logoColor=FFFFFF)](https://hub.docker.com/r/linuxserver/taisun)
[![Build Status](https://ci.linuxserver.io/view/all/job/Docker-Pipeline-Builders/job/docker-taisun/job/master/badge/icon?style=flat-square)](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:
[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
* 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
@ -20,18 +31,19 @@ Simply pulling `linuxserver/taisun` should retrieve the correct image for your a
The architectures supported by this image are:
| Architecture | Tag |
| :---: | :--- |
| :----: | --- |
| x86-64 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker
```text
```
docker create \
--name=taisun \
-p 3000:3000 \
@ -40,6 +52,7 @@ docker create \
linuxserver/taisun
```
### docker-compose
Compatible with docker-compose v2 schemas.
@ -57,39 +70,44 @@ services:
ports:
- 3000:3000
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 `<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.
Docker 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.
### Ports \(`-p`\)
### Ports (`-p`)
| Parameter | Function |
| :---: | :--- |
| :----: | --- |
| `3000` | Taisun WebUI. |
### Environment Variables \(`-e`\)
### Environment Variables (`-e`)
| Env | Function |
| :---: | :--- |
| :----: | --- |
### Volume Mappings \(`-v`\)
### Volume Mappings (`-v`)
| Volume | Function |
| :---: | :--- |
| :----: | --- |
| `/var/run/docker.sock` | Docker Socket on the system |
## Application Setup
The webui is at [http://localhost:3000](http://localhost:3000), for more information on usage see [here](https://github.com/Taisun-Docker/taisun/wiki/Usage).
The webui is at http://localhost:3000, for more information on usage see [here](https://github.com/Taisun-Docker/taisun/wiki/Usage).
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27taisun%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=taisun "view available mods for this container.")
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?style=for-the-badge&color=E68523&label=mods&query=%24.mods%5B%27taisun%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=taisun)
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) can be accessed via the dynamic badge above.
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\) can be accessed via the dynamic badge above.
## Support Info
@ -110,4 +128,3 @@ We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to
* **30.03.19:** - Updating docker-compose build dependancies for musl libc.
* **23.03.19:** - Switching to new Base images, shift to arm32v7 tag.
* **13.02.19:** - Initial release.