code-server_ynh/README.md

code-server for YunoHost

Lire ce readme en français.

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 to learn how to install it.

Overview

Run VS Code on your server and access it in the browser

Shipped version: 3.10.2~ynh2

Screenshots

Disclaimers / important information

Limitations

• Requires a dedicated domain
• Single-user, no LDAP
• Subdomains for services on ports (like 8080.code-server-domain.tld) are not supported

Other info

• 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!
• You can optionally set a password required to access code-server. Don't leave this blank if you have allowed public access!

Documentation and resources

• Official app website: https://github.com/cdr/code-server
• Official user documentation: https://github.com/cdr/code-server/tree/main/docs
• Official admin documentation: https://github.com/cdr/code-server/tree/main/docs
• Upstream app code repository: https://github.com/cdr/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.

To try the testing branch, please proceed like that.

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