-
Notifications
You must be signed in to change notification settings - Fork 4
Add coder-on-railway blog post #11
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
7 commits
Select commit
Hold shift + click to select a range
f9efe4f
Add coder-on-railway
matifali f4daf30
use branch links
matifali fb594f4
Update railway.md
matifali ef57771
moved to packages repo.
matifali 11e0ab1
wip
matifali e9f85c0
revert fly.io
matifali 5de39db
suggestions
matifali File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
wip
- Loading branch information
commit 11e0ab19dcd018249131a5ad83a0c7a0a6fd6899
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,13 +1,61 @@ | ||
<div align="center"> | ||
<a href="https://coder.com"> | ||
<img src="https://raw.githubusercontent.com/coder/coder/main/docs/images/banner-white.png" style="width: 650px"> | ||
</a> | ||
</div> | ||
# Deploy Coder on Railway.app | ||
|
||
## Deploy Instructions | ||
Coder can be deployed on Railway.app in just a few clicks. This guide will walk you through the process of deploying Coder on Railway.app. | ||
|
||
Coder provides a | ||
## Quickstart | ||
|
||
[Quickstart](#quickstart) | [Docs](https://coder.com/docs) | [Why Coder](https://coder.com/why) | [Enterprise](https://coder.com/docs/v2/latest/enterprise) | ||
Start your deployment by clicking the button below. This will take you to Railway.app where you can sign up for a free account and deploy Coder. | ||
|
||
[](https://discord.gg/coder) | ||
[](https://railway.app/template/cUQ8_P?referralCode=tfH8Uw) | ||
|
||
### 1. Fill the environment variables | ||
|
||
The current version of the template allows you to set an optional environment variable `CODER_WILDCARD_ACCESS_URL` which will allow you to forward ports from your workspace to a custom wildcard subdomain of the URL you provide. This is useful if you want to access a service running in your workspace from a browser. For example, if you set `CODER_WILDCARD_ACCESS_URL` to `*.coder.example.com`, you can access a service running on port 8080 in your workspace by visiting `8080--<username>--<workspace-name>.coder.example.com`. | ||
matifali marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 2. Attach a custom domain | ||
|
||
Your Coder deployment will always be accessible at `https://<app-name>.up.railway.app`. If you want to use a custom domain, you can do so by going to Dashboard > Coder (Service) > Settings > Domains and adding your domain and optionally a wildcard subdomain if you specified `CODER_WILDCARD_ACCESS_URL` in the previous step. | ||
matifali marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
||
### 3. Create your first user | ||
|
||
Create your first user by going to `https://<app-name>.up.railway.app` or your custom domain. | ||
|
||
 | ||
|
||
### 3. Create your first template | ||
|
||
[**Templates**](https://coder.com/docs/v2/latest/templates): Templates are written in Terraform and describe the infrastructure for workspaces. Coder provides a set of starter templates to help you get started. | ||
|
||
Choose a template to set up your first workspace. You can also [create your own templates](https://coder.com/docs/v2/latest/templates) to define your custom infrastructure with your preferred cloud provider. | ||
 | ||
|
||
### 4. Create your first workspace | ||
|
||
[**Workspaces**](https://coder.com/docs/v2/latest/workspaces): Workspaces contain the IDEs, dependencies, and configuration information needed for software development. You can create workspaces from templates. Here wea are showing the workspaces created from the Fly.io starter template in action. | ||
 | ||
|
||
## Documentation | ||
|
||
Browse our [**docs**](https://coder.com/docs/v2) or visit a specific section below: | ||
|
||
[**Templates**](https://coder.com/docs/v2/latest/templates) | [**Workspaces**](https://coder.com/docs/v2/latest/workspaces) | [**IDEs**](https://coder.com/docs/v2/latest/ides) | [**Administration**](https://coder.com/docs/v2/latest/admin) | [**Enterprise**](https://coder.com/docs/v2/latest/enterprise) | ||
|
||
## Community and Support | ||
|
||
Feel free to [open an issue](https://github.com/coder/coder/issues/new) if you have questions, run into bugs, or have a feature request. | ||
|
||
[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress features, and chat with the community using Coder! [](https://discord.gg/coder) | ||
|
||
## Related | ||
|
||
We are always working on new integrations. Feel free to open an issue to request an integration. Contributions are welcome in any official or community repositories. | ||
|
||
### Official | ||
|
||
- [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click | ||
- [**JetBrains Gateway Extension**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click | ||
|
||
### Community | ||
|
||
- [**Coder GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates | ||
- [**Various Templates**](https://github.com/coder/coder/examples/templates/community-templates.md): Hetzner Cloud, Docker in Docker, and other templates the community has built. | ||
matifali marked this conversation as resolved.
Show resolved
Hide resolved
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,61 +0,0 @@ | ||
# Deploy Coder on Railway.app | ||
|
||
Coder can be deployed on Railway.app in just a few clicks. This guide will walk you through the process of deploying Coder on Railway.app. | ||
|
||
## Quickstart | ||
|
||
Start your deployment by clicking the button below. This will take you to Railway.app where you can sign up for a free account and deploy Coder. | ||
|
||
[](https://railway.app/template/cUQ8_P?referralCode=tfH8Uw) | ||
|
||
### 1. Fill the environment variables | ||
|
||
The current version of the template allows you to set an optional environment variable `CODER_WILDCARD_ACCESS_URL` which will allow you to forward ports from your workspace to a custom wildcard subdomain of the URL you provide. This is useful if you want to access a service running in your workspace from a browser. For example, if you set `CODER_WILDCARD_ACCESS_URL` to `*.coder.example.com`, you can access a service running on port 8080 in your workspace by visiting `8080--<username>--<workspace-name>.coder.example.com`. | ||
|
||
### 2. Attach a custom domain | ||
|
||
Your Coder deployment will always be accessible at `https://<app-name>.up.railway.app`. If you want to use a custom domain, you can do so by going to Dashboard > Coder (Service) > Settings > Domains and adding your domain and optionally a wildcard subdomain if you specified `CODER_WILDCARD_ACCESS_URL` in the previous step. | ||
|
||
### 3. Create your first user | ||
|
||
Create your first user by going to `https://<app-name>.up.railway.app` or your custom domain. | ||
|
||
 | ||
|
||
### 3. Create your first template | ||
|
||
[**Templates**](https://coder.com/docs/v2/latest/templates): Templates are written in Terraform and describe the infrastructure for workspaces. Coder provides a set of starter templates to help you get started. | ||
|
||
Choose a template to set up your first workspace. You can also [create your own templates](https://coder.com/docs/v2/latest/templates) to define your custom infrastructure with your preferred cloud provider. | ||
 | ||
|
||
### 4. Create your first workspace | ||
|
||
[**Workspaces**](https://coder.com/docs/v2/latest/workspaces): Workspaces contain the IDEs, dependencies, and configuration information needed for software development. You can create workspaces from templates. Here wea are showing the workspaces created from the Fly.io starter template in action. | ||
 | ||
|
||
## Documentation | ||
|
||
Browse our [**docs**](https://coder.com/docs/v2) or visit a specific section below: | ||
|
||
[**Templates**](https://coder.com/docs/v2/latest/templates) | [**Workspaces**](https://coder.com/docs/v2/latest/workspaces) | [**IDEs**](https://coder.com/docs/v2/latest/ides) | [**Administration**](https://coder.com/docs/v2/latest/admin) | [**Enterprise**](https://coder.com/docs/v2/latest/enterprise) | ||
|
||
## Community and Support | ||
|
||
Feel free to [open an issue](https://github.com/coder/coder/issues/new) if you have questions, run into bugs, or have a feature request. | ||
|
||
[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress features, and chat with the community using Coder! [](https://discord.gg/coder) | ||
|
||
## Related | ||
|
||
We are always working on new integrations. Feel free to open an issue to request an integration. Contributions are welcome in any official or community repositories. | ||
|
||
### Official | ||
|
||
- [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click | ||
- [**JetBrains Gateway Extension**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click | ||
|
||
### Community | ||
|
||
- [**Coder GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates | ||
- [**Various Templates**](https://github.com/coder/coder/examples/templates/community-templates.md): Hetzner Cloud, Docker in Docker, and other templates the community has built. | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.