1
0
Fork 0
mirror of https://github.com/YunoHost-Apps/code-server_ynh.git synced 2024-09-03 18:16:28 +02:00
code-server_ynh/README.md
2022-07-20 06:12:28 +00:00

64 lines
2.6 KiB
Markdown

<!--
N.B.: This README was automatically generated by https://github.com/YunoHost/apps/tree/master/tools/README-generator
It shall NOT be edited by hand.
-->
# code-server for YunoHost
[![Integration level](https://dash.yunohost.org/integration/code-server.svg)](https://dash.yunohost.org/appci/app/code-server) ![Working status](https://ci-apps.yunohost.org/ci/badges/code-server.status.svg) ![Maintenance status](https://ci-apps.yunohost.org/ci/badges/code-server.maintain.svg)
[![Install code-server with YunoHost](https://install-app.yunohost.org/install-with-yunohost.svg)](https://install-app.yunohost.org/?app=code-server)
*[Lire ce readme en français.](./README_fr.md)*
> *This package allows you to install code-server quickly and simply on a YunoHost server.
If you don't have YunoHost, please consult [the guide](https://yunohost.org/#/install) to learn how to install it.*
## Overview
Run VS Code on your server and access it in the browser
**Shipped version:** 4.5.1~ynh1
## Screenshots
![Screenshot of code-server](./doc/screenshots/screenshot.png)
## Disclaimers / important information
### Installation
* The package does not create a dedicated system user, rather during installation you are asked what user you want code-server to run as. **Don't give access to users you don't fully trust!**
### Limitations
* Requires a dedicated domain
* Single-user, no LDAP
* Subdomains for services on ports (like 8080.code-server-domain.tld) are not supported
### Extensions
This application uses [Open VSX Registry](https://open-vsx.org/). You can change this setting from the web admin config panel.
See https://coder.com/docs/code-server/latest/FAQ#how-do-i-use-my-own-extensions-marketplace
## Documentation and resources
* Official user documentation: <https://coder.com/docs/code-server/latest/FAQ>
* Official admin documentation: <https://coder.com/docs/code-server/latest>
* Upstream app code repository: <https://github.com/coder/code-server>
* YunoHost documentation for this app: <https://yunohost.org/app_code-server>
* Report a bug: <https://github.com/YunoHost-Apps/code-server_ynh/issues>
## Developer info
Please send your pull request to the [testing branch](https://github.com/YunoHost-Apps/code-server_ynh/tree/testing).
To try the testing branch, please proceed like that.
``` bash
sudo yunohost app install https://github.com/YunoHost-Apps/code-server_ynh/tree/testing --debug
or
sudo yunohost app upgrade code-server -u https://github.com/YunoHost-Apps/code-server_ynh/tree/testing --debug
```
**More info regarding app packaging:** <https://yunohost.org/packaging_apps>