From fdb457b2fca7e2d617deb7f852525e8553c2c9ca Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Sat, 1 Apr 2023 15:41:47 +0300 Subject: [PATCH 1/4] Add content for railway template description --- railway/railway.md | 81 ++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 81 insertions(+) create mode 100644 railway/railway.md diff --git a/railway/railway.md b/railway/railway.md new file mode 100644 index 0000000..d6b64f5 --- /dev/null +++ b/railway/railway.md @@ -0,0 +1,81 @@ +--- +Documentation for Railway Template for Coder +https://railway.app/template/cUQ8_P?referralCode=tfH8Uw +--- + +
+ + + +

+ Self-Hosted Remote Development Environments +

+ + + +
+ +[Coder](https://coder.com) enables organizations to set up development environments in the cloud. Environments are defined with Terraform, connected through a secure high-speed Wireguard® tunnel, and are automatically shut down when not in use to save on costs. Coder gives engineering teams the flexibility to use the cloud for workloads that are most beneficial to them. + +- Define development environments in Terraform + - EC2 VMs, Kubernetes Pods, Docker Containers, etc. +- Automatically shutdown idle resources to save on costs +- Onboard developers in seconds instead of days + +## Quickstart + +### 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--app-name-workspace-name-.coder.example.com` in your browser. + +> Note: This is an optional step. If you do not set this variable, you will not be able to access services running in your workspace from a browser. For more information. + +> You can later add more environment variables by going to Dashboard > Coder (Service) > Settings > Environment Variables. See [this](https://coder.com/docs/v2/latest/cli/server) for more information on environment variables that can be set. + +### 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. + +![Welcome to Coder](https://raw.githubusercontent.com/coder/blogs/coder-on-railway/posts/coder-on-railway/static/coder_setup.png) + +### 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. +![starter templates](https://raw.githubusercontent.com/coder/blogs/coder-on-railway/posts/coder-on-railway/static/starter_templates_welcome.png) + +### 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. +![fly.io workspace](https://raw.githubusercontent.com/coder/blogs/coder-on-railway/posts/coder-on-railway/static/fly_workspace.png) + +## 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! [![discord](https://img.shields.io/discord/747933592273027093?label=discord)](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. From d84c45062a720d4f8100c4f7414b59d857edaef1 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Tue, 4 Apr 2023 12:14:28 +0300 Subject: [PATCH 2/4] changes after review --- railway/railway.md | 27 +++++---------------------- 1 file changed, 5 insertions(+), 22 deletions(-) diff --git a/railway/railway.md b/railway/railway.md index d6b64f5..4f28650 100644 --- a/railway/railway.md +++ b/railway/railway.md @@ -28,9 +28,9 @@ https://railway.app/template/cUQ8_P?referralCode=tfH8Uw 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--app-name-workspace-name-.coder.example.com` in your browser. -> Note: This is an optional step. If you do not set this variable, you will not be able to access services running in your workspace from a browser. For more information. +> Note: This is an optional step. If you do not set this variable, you will not be able to access services running in your workspace from a browser. For more information. You have to use a custom domain with Railway and cannot use railway's built-in domain for this wildcard. -> You can later add more environment variables by going to Dashboard > Coder (Service) > Settings > Environment Variables. See [this](https://coder.com/docs/v2/latest/cli/server) for more information on environment variables that can be set. +> Note: You can set environment variables by going to _Dashboard > Coder (Service) > Settings > Environment Variables_. See our [docs](https://coder.com/docs/v2/latest/cli/server) for more information on environment variables that can be set. ### 2. Attach a custom domain @@ -54,28 +54,11 @@ Choose a template to set up your first workspace. You can also [create your own [**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. ![fly.io workspace](https://raw.githubusercontent.com/coder/blogs/coder-on-railway/posts/coder-on-railway/static/fly_workspace.png) -## 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! [![discord](https://img.shields.io/discord/747933592273027093?label=discord)](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 - +- [**Coder on GitHub**](https://github.com/coder/coder) +- [**Coder docs**](https://coder.com/docs/v2) - [**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. +- - [![Coder discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder) From a2c7096ba7181c8e989ea0a7968d7798507641f4 Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Tue, 4 Apr 2023 12:14:53 +0300 Subject: [PATCH 3/4] fix bullets --- railway/railway.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/railway/railway.md b/railway/railway.md index 4f28650..5ca03bd 100644 --- a/railway/railway.md +++ b/railway/railway.md @@ -61,4 +61,4 @@ Choose a template to set up your first workspace. You can also [create your own - [**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. -- - [![Coder discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder) +- [![Coder discord](https://img.shields.io/discord/747933592273027093?label=discord)](https://discord.gg/coder) From 3b25aa042ee5b1ddded7ddc201e2e84f9be9036c Mon Sep 17 00:00:00 2001 From: Muhammad Atif Ali Date: Tue, 4 Apr 2023 12:17:34 +0300 Subject: [PATCH 4/4] reduce marketing --- railway/railway.md | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/railway/railway.md b/railway/railway.md index 5ca03bd..62362cf 100644 --- a/railway/railway.md +++ b/railway/railway.md @@ -3,18 +3,6 @@ Documentation for Railway Template for Coder https://railway.app/template/cUQ8_P?referralCode=tfH8Uw --- -
- - - -

- Self-Hosted Remote Development Environments -

- - - -
- [Coder](https://coder.com) enables organizations to set up development environments in the cloud. Environments are defined with Terraform, connected through a secure high-speed Wireguard® tunnel, and are automatically shut down when not in use to save on costs. Coder gives engineering teams the flexibility to use the cloud for workloads that are most beneficial to them. - Define development environments in Terraform