https://github.com/recursionpharma/bc_code
Code Server Interactive App for BioHive Portal (Open OnDemand)
https://github.com/recursionpharma/bc_code
Last synced: 5 months ago
JSON representation
Code Server Interactive App for BioHive Portal (Open OnDemand)
- Host: GitHub
- URL: https://github.com/recursionpharma/bc_code
- Owner: recursionpharma
- License: gpl-3.0
- Created: 2023-09-07T18:34:22.000Z (almost 3 years ago)
- Default Branch: trunk
- Last Pushed: 2025-06-05T18:09:10.000Z (about 1 year ago)
- Last Synced: 2025-06-05T19:21:58.747Z (about 1 year ago)
- Language: HTML
- Size: 126 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://infosec-docs.prod.rxrx.io/octoguard/scorecards/bc_code)
[](https://infosec-docs.prod.rxrx.io/octoguard/scorecards/bc_code)
[](https://infosec-docs.prod.rxrx.io/octoguard/team-reports/information-technology)
# Batch Connect - OSC Code Server
[](https://opensource.org/licenses/MIT)
An improved file viewer / editor for OSC OnDemand that launches a
Code Server within an Owens batch job. Code Server leverages VSCode as its
editor.
## Prerequisites
This Batch Connect app requires the following software be installed on the
**compute nodes** that the batch job is intended to run on (**NOT** the
OnDemand node):
- [Lmod] 6.0.1+ or any other `module purge` and `module load ` based
CLI used to load appropriate environments within the batch job before
launching Code server.
- [Code Server] 2.x+ available from Github: https://github.com/cdr/code-server/releases
[Code Server]: https://coder.com/
[Lmod]: https://www.tacc.utexas.edu/research-development/tacc-projects/lmod
[VS Code]: https://code.visualstudio.com/
## Install
1. Use Git to clone this app and checkout the desired branch/version you want to
use and place this wherever you store batch connect apps (`/var/www/ood/apps/sys` or `~/ondemand/dev`):
```sh
scl enable git29 -- git clone
cd
scl enable git29 -- git checkout
```
2. Deploy code-server on your systems.
```sh
# replace URL with latest release from code-server
wget https://github.com/cdr/code-server/releases/download/3.2.0/code-server-3.2.0-linux-x86_64.tar.gz
tar -xzf code-server-3.2.0-linux-x86_64.tar.gz
```
3. You will notice code-server is an executable inside that directory and can get the full path:
```sh
$ readlink -f code-server-3.2.0-linux-x86_64.tar.gz
/users/PZS0562/efranz/code-server-3.2.0-linux-x86_64.tar.gz
```
4. Update the path to the code-server binary in the script https://github.com/OSC/bc_osc_codeserver/blob/3082790ee69c82fe6fe757074da7d8d18c7d7e3d/template/script.sh.erb#L27:
```diff
# An arbitrary path...
- /fs/project/PZS0714/mrodgers/bin/code-server-2.1523-vsc1.38.1 \
+ /users/PZS0562/efranz/code-server-3.2.0-linux-x86_64/code-server \
--auth=password \
--port="$port" \
```
5. Update form.yml to use the correct cluster, and any other changes as necessary to form.yml or submit.yml that is appropriate for your cluster.
## Update
To update the app you would:
```sh
cd
scl enable git29 -- git fetch
scl enable git29 -- git checkout
```
Again, you do not need to restart the app as it isn't a Passenger app.
## Known Issues
- In-app installation of extensions does not work
- The authentication provided by code-server is unencrypted
## Contributing
1. Fork it ( https://github.com/OSC/bc_osc_codeserver/fork )
2. Create your feature branch (`git checkout -b my-new-feature`)
3. Commit your changes (`git commit -am 'Add some feature'`)
4. Push to the branch (`git push origin my-new-feature`)
5. Create a new Pull Request