Skip to content

Latest commit

 

History

History
84 lines (46 loc) · 3.44 KB

README.md

File metadata and controls

84 lines (46 loc) · 3.44 KB
Raw

Coder OSS help

This is an FAQ, tips and tricks, and best practices to get you going with Coder v2 OSS and v2 Enterprise (paid). If you're looking for an v2 enterprise trial key, fill out this form for a 30-day trial or you can sign up when creating your admin user after deploying Coder.

Here is an additional repo coder-hw with a Python-based CLI using the Coder API.

The official v2 docs and template examples are great resources too. Also my colleague bpmct authors some amazing templates too.

Main menu screenshot

API examples

You can find API endpoints from inspecting the UI in your browser tools. Here are examples to get you going. This new repo coder-hw heavily uses the Coder API with a Python-based CLI app.

Template Emoji URLs

Here are several Emoji URLs to IDE, programming language, and infrastructure emojis to make your templates pop in the Coder UI.

Frequently Asked Questions (FAQ)

Coder's docs are the first place to answers but I compile things that I find are important or recurring. Here is the FAQ.

Easiest way to getting started

The easiest and fastest way to run Coder is from the command line with the coder binary.

Download it here

curl -fsSL https://coder.com/install.sh | sh

To specify a version and dry run before actually installing

 curl -L https://coder.com/install.sh | sh -s -- --dry-run --version 2.10.0

Using fsS along with L, causes curl to fail silently on server errors, preventing showing the progress meter, and still show an error if it fails.

If you're on macOS and not a fan of brew like me, make sure you run this command instead:

curl -fsSL https://coder.com/install.sh | sh -s -- --method standalone

BTW, the coder binary is also the Coder CLI, which you use to create, push templates, even create, start, stop workspaces, API Key tokens, etc.

You can pass parameters/flags after coder server but I have a nice coder.yaml to easily tweak settings.

coder server --config coder.yaml

Templates

The example templates that ship with v2 are here and bpmct has some sweet templates too like podman and nifty AWS VM template that only persists the home volume.

Main menu screenshot

Videos

Here are some short videos installing, configuring and using Coder v2. As new features arrive, I add new videos.

License

This project is licensed under the MIT License

Contributing

Disclaimer: Unmaintained and Untested Code

Please note that this program is not actively maintained or tested. While it may work as intended, it's possible that it will break or behave unexpectedly due to changes in dependencies, environments, or other factors.

Use this program at your own risk, and be aware that:

  1. Bugs may not be fixed
  2. Compatibility issues may arise
  3. Security vulnerabilities may exist

If you encounter any issues or have concerns, feel free to open an issue or submit a pull request.