Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nullpo-head/Out-of-the-Box-CodeServer
OOTB Code-Server is an out-of-the-box Code-Server environment. It provides Https proxy, GItHub authorization and automatic shutdown with just a few settings.
https://github.com/nullpo-head/Out-of-the-Box-CodeServer
Last synced: about 14 hours ago
JSON representation
OOTB Code-Server is an out-of-the-box Code-Server environment. It provides Https proxy, GItHub authorization and automatic shutdown with just a few settings.
- Host: GitHub
- URL: https://github.com/nullpo-head/Out-of-the-Box-CodeServer
- Owner: nullpo-head
- License: mit
- Created: 2020-05-17T09:53:44.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2020-09-20T08:15:24.000Z (about 4 years ago)
- Last Synced: 2024-08-01T10:16:05.609Z (3 months ago)
- Language: Shell
- Homepage:
- Size: 419 KB
- Stars: 84
- Watchers: 3
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
# OOTB Code-Server
OOTB Code-Server is an out-of-the-box [Code-Server](https://github.com/cdr/code-server) environment.
[Code-Server](https://github.com/cdr/code-server) is an OSS product developed by [Coder technologies](https://coder.com/) that allows you to run [VS Code](https://github.com/Microsoft/vscode) on any machine and to access it in the browser.
However, to install Code-Server on a server, you have to set up an Https proxy server, an authentication mechanism for security, automatic shutdown if the server is hosted in the cloud, and much more.
OOTB Code-Server provides these mechanisims with just a few settings.
OOTB Code-Server is equipped with
1. HTTPS powered by Let's Encrypt and [https-portal](https://github.com/SteveLTN/https-portal)
2. Authorization by your GitHub account powered by [OAuth2 Proxy](https://github.com/oauth2-proxy/oauth2-proxy)
3. Mutable LXC Code-Server container, inside which you can do any mutable things as you usually do in an Ubuntu machine
4. Automatic deallocation of your VM after 15-minutes idle time (Currently Azure VM is supported)
OOTB Code-Server consists of Docker-Compose containers for immutable components such as Https proxy and GitHub auth proxy,
and a LXC container for mutable Code-Server environment.
## Getting Started
### 0. Prerequisites
Please install `docker`, `docker-compose`, and `lxd`. Ubuntu has `lxd` by default.
### 1. Clone this repository
Please clone this repository to a good location
```bash
$ git clone https://github.com/nullpo-head/Out-of-Box-CodeServer-Environment.git ~/ootb-code-server
```
### 2. Set up environment variables
1. Copy `.env.example` to `.env`
```bash
$ cd ootb-code-server
$ cp ./helper_containers/.env.example ./helper_containers/.env
```
Pleaes edit `.env` as follows
2. DNS Name
Rewrite `CODER_HOST` to your server's DNS name. Let's Encrypt will issue a certificate for this domain.
For example, if you use an Azure VM, it has a name like this
```
CODER_HOST=my-ootb-codeserver.japaneast.cloudapp.azure.com
```
3. GitHub Authorization
Create a new OAuth App at https://github.com/settings/developers.
"Homepage URL" is the domain you host your code-server. Let's suppose it's `https://yourdomain.com` here. Then, "Authorization callback URL" is `https://yourdomain.com/oauth2/callback`. Please note that you use `https://` because OOTB Code-Server enables https.
If you want to know more about this settings, please refer to [the doc of OAuth2 Proxy](https://oauth2-proxy.github.io/oauth2-proxy/)
Please fill in `OAUTH2_PROXY_CLIENT_ID` and `OAUTH2_PROXY_CLIENT_SECRET` in `.env` according to the app you created.
Put your email address in `emails` file. Only the email address listed here are allowed to login to your Code-Server.
```bash
$ echo '[email protected]' > ~/ootb-code-server/helper_containers/emails
```
4. **(Optional)** Automatic Deallocation of Your VM (Azure is only supporeted)
If you enable automatic deallocation of your VM,
rewrite `HEARTBEATS_ACTION` so that it corresponds to your VM.
```
HEARTBEATS_ACTION="az vm deallocate --subscription 'Put Your Subscription Here' -g 'Put Your Resource Group Name Here' -n 'Put Your VM Name Here"
```
You can set `HEARTBEATS_TIMEOUT` to determine how many minutes of idle time the VM will deallocate after. The default minutes is 15.
By this configuration, your Azure VM is deallocated after Code-Server is idle for 15 minutes and there is no session of ssh and Bash for 15 minutes.
Azure VM is only supported right now because the author is an Azure user. Any PRs to support other clouds are welcome.
__NOTE__: Automatic deallocation doesn't work if you connect to Code-Server from iPad. Please see [the issue of Code-Server](https://github.com/cdr/code-server/issues/2061).
### 3. Initialize OOTB Code-Server
**First**, please make sure that `80` and `443` ports are not used by other web servers.
Installtion will fail if they are not available. If it fails, re-run `install.sh` after making those ports available.
Run `install.sh`, following the instruction it prompts.
```bash
$ ./install.sh
```
After that, you can access your Code-Server at `https://your-host-name`.
Containers of OOTB Code-Server will automatically launch when your server starts.
## Stop / Start / Monitor Containers
OOTB Code-Server consists of Docker Compose and LXD. So, you can controll containers by `docker-compose` and `lxc`.
### Stop
```bash
$ lxc stop ootb-code-server
$ cd ~/ootb-code-server/helper_containers
$ sudo docker-compose stop # or `down` to delete containers
```
### Start
You can start them again by
```bash
$ lxc start ootb-code-server
$ cd ~/ootb-code-server/helper_containers
```
1. If you don't enable automatic VM deallocation,
```bash
$ sudo docker-compose up -d https-portal oauth2-proxy
```
2. If you enable automatic VM deallocation,
```bash
$ sudo docker-compose up -d
```
They will launch automatically when your server launces, as long as they are running when you shutdown your server.
### Monitor
You can monitor containers by
```bash
$ lxc ls
+------------------+---------+---------------------+--------+------------+-----------+
| NAME | STATE | IPV4 | IPV6 | TYPE | SNAPSHOTS |
+------------------+---------+---------------------+--------+------------+-----------+
| ootb-code-server | RUNNING | 10.238.18.27 (eth0) | | PERSISTENT | 0 |
+------------------+---------+---------------------+--------+------------+-----------+
```
and
```bash
$ cd ~/ootb-code-server/helper_containers
$ sudo docker-compose ps
CONTAINER ID IMAGE COMMAND CREATED STATUS PORTS NAMES
7c9806549c66 steveltn/https-portal:1 "/init" 2 hours ago Up 2 hours 0.0.0.0:80->80/tcp, 0.0.0.0:443->443/tcp helper_containers_https-portal_1
6f0ce90981c9 quay.io/oauth2-proxy/oauth2-proxy "/bin/oauth2-proxy" 2 hours ago Up 2 hours helper_containers_oauth2-proxy_1
```