mirror of
https://github.com/coder/coder.git
synced 2026-09-21 20:51:01 +08:00
docs: convert alerts to use GitHub Flavored Markdown (GFM) (#16850)
followup to #16761 thanks @lucasmelin ! + thanks: @ethanndickson @Parkreiner @matifali @aqandrew - [x] update snippet - [x] find/replace - [x] spot-check [preview](https://coder.com/docs/@16761-gfm-callouts/admin/templates/managing-templates/schedule) (and others) --------- Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com> Co-authored-by: M Atif Ali <atif@coder.com>
This commit is contained in:
Edward Angert
co-authored by
EdwardAngert
M Atif Ali
EdwardAngert
M Atif Ali
parent
e817713dc0
commit
101b62dc3e
@@ -39,9 +39,9 @@ module "git-clone" {
|
||||
}
|
||||
```
|
||||
|
||||
> You can edit the template using an IDE or terminal of your preference, or by
|
||||
> going into the
|
||||
> [template editor UI](../admin/templates/creating-templates.md#web-ui).
|
||||
You can edit the template using an IDE or terminal of your preference, or by
|
||||
going into the
|
||||
[template editor UI](../admin/templates/creating-templates.md#web-ui).
|
||||
|
||||
You can also use
|
||||
[template parameters](../admin/templates/extending-templates/parameters.md) to
|
||||
@@ -63,9 +63,9 @@ module "git-clone" {
|
||||
}
|
||||
```
|
||||
|
||||
> If you need more customization, you can read the
|
||||
> [Git Clone module](https://registry.coder.com/modules/git-clone) documentation
|
||||
> to learn more about the module.
|
||||
If you need more customization, you can read the
|
||||
[Git Clone module](https://registry.coder.com/modules/git-clone) documentation
|
||||
to learn more about the module.
|
||||
|
||||
Don't forget to build and publish the template changes before creating a new
|
||||
workspace. You can check if the repository is cloned by accessing the workspace
|
||||
|
||||
@@ -11,12 +11,12 @@ December 13, 2023
|
||||
|
||||
---
|
||||
|
||||
> Okta is an identity provider that can be used for OpenID Connect (OIDC) Single
|
||||
> Sign On (SSO) on Coder.
|
||||
Okta is an identity provider that can be used for OpenID Connect (OIDC) Single
|
||||
Sign On (SSO) on Coder.
|
||||
|
||||
To configure custom claims in Okta to support syncing roles and groups with
|
||||
Coder, you must first have setup an Okta application with
|
||||
[OIDC working with Coder](https://coder.com/docs/admin/auth#openid-connect).
|
||||
[OIDC working with Coder](../admin/users/oidc-auth.md).
|
||||
From here, we will add additional claims for Coder to use for syncing groups and
|
||||
roles.
|
||||
|
||||
@@ -37,10 +37,10 @@ In the “OpenID Connect ID Token” section, turn on “Groups Claim Type” an
|
||||
the “Claim name” to `groups`. Optionally configure a filter for which groups to
|
||||
be sent.
|
||||
|
||||
> !! If the user does not belong to any groups, the claim will not be sent. Make
|
||||
> sure the user authenticating for testing is in at least 1 group. Defer to
|
||||
> [troubleshooting](https://coder.com/docs/admin/auth#troubleshooting) with
|
||||
> issues
|
||||
> [!IMPORTANT]
|
||||
> If the user does not belong to any groups, the claim will not be sent. Make
|
||||
> sure the user authenticating for testing is in at least one group. Defer to
|
||||
> [troubleshooting](../admin/users/index.md) with issues.
|
||||
|
||||
|
||||
|
||||
|
||||
@@ -123,10 +123,10 @@ icons except the web terminal.
|
||||
|
||||
## I want to allow code-server to be accessible by other users in my deployment
|
||||
|
||||
> It is **not** recommended to share a web IDE, but if required, the following
|
||||
> deployment environment variable settings are required.
|
||||
We don't recommend that you share a web IDE, but if you need to, the following
|
||||
deployment environment variable settings are required.
|
||||
|
||||
Set deployment (Kubernetes) to allow path app sharing
|
||||
Set deployment (Kubernetes) to allow path app sharing:
|
||||
|
||||
```yaml
|
||||
# allow authenticated users to access path-based workspace apps
|
||||
@@ -160,8 +160,8 @@ If the [`CODER_ACCESS_URL`](../admin/setup/index.md#access-url) is not
|
||||
accessible from a workspace, the workspace may build, but the agent cannot reach
|
||||
Coder, and thus the missing icons. e.g., Terminal, IDEs, Apps.
|
||||
|
||||
> By default, `coder server` automatically creates an Internet-accessible
|
||||
> reverse proxy so that workspaces you create can reach the server.
|
||||
By default, `coder server` automatically creates an Internet-accessible
|
||||
reverse proxy so that workspaces you create can reach the server.
|
||||
|
||||
If you are doing a standalone install, e.g., on a MacBook and want to build
|
||||
workspaces in Docker Desktop, everything is self-contained and workspaces
|
||||
@@ -171,8 +171,8 @@ workspaces in Docker Desktop, everything is self-contained and workspaces
|
||||
coder server --access-url http://localhost:3000 --address 0.0.0.0:3000
|
||||
```
|
||||
|
||||
> Even `coder server` which creates a reverse proxy, will let you use
|
||||
> <http://localhost> to access Coder from a browser.
|
||||
Even `coder server` which creates a reverse proxy, will let you use
|
||||
<http://localhost> to access Coder from a browser.
|
||||
|
||||
## I updated a template, and an existing workspace based on that template fails to start
|
||||
|
||||
|
||||
@@ -15,8 +15,8 @@ authenticate the Coder control plane to AWS and create an EC2 workspace. The
|
||||
below steps assume your Coder control plane is running in Google Cloud and has
|
||||
the relevant service account assigned.
|
||||
|
||||
> For steps on assigning a service account to a resource like Coder,
|
||||
> [see the Google documentation here](https://cloud.google.com/iam/docs/attach-service-accounts#attaching-new-resource)
|
||||
For steps on assigning a service account to a resource like Coder, visit the
|
||||
[Google documentation](https://cloud.google.com/iam/docs/attach-service-accounts#attaching-new-resource).
|
||||
|
||||
## 1. Get your Google service account OAuth Client ID
|
||||
|
||||
@@ -24,8 +24,8 @@ Navigate to the Google Cloud console, and select **IAM & Admin** > **Service
|
||||
Accounts**. View the service account you want to use, and copy the **OAuth 2
|
||||
Client ID** value shown on the right-hand side of the row.
|
||||
|
||||
> (Optional): If you do not yet have a service account,
|
||||
> [here is the Google IAM documentation on creating a service account](https://cloud.google.com/iam/docs/service-accounts-create).
|
||||
Optionally: If you do not yet have a service account, use the
|
||||
[Google IAM documentation on creating a service account](https://cloud.google.com/iam/docs/service-accounts-create) to create one.
|
||||
|
||||
## 2. Create AWS role
|
||||
|
||||
@@ -122,7 +122,8 @@ gcloud auth print-identity-token --audiences=https://aws.amazon.com --impersonat
|
||||
veloper.gserviceaccount.com --include-email
|
||||
```
|
||||
|
||||
> Note: Your `gcloud` client may needed elevated permissions to run this
|
||||
> [!NOTE]
|
||||
> Your `gcloud` client may needed elevated permissions to run this
|
||||
> command.
|
||||
|
||||
## 5. Set identity token in Coder control plane
|
||||
|
||||
@@ -72,6 +72,5 @@ coder:
|
||||
postgres://<user>:<password>@databasehost:<port>/<db-name>?sslmode=verify-full&sslrootcert="/home/coder/.postgresql/postgres-root.crt"
|
||||
```
|
||||
|
||||
> More information on connecting to PostgreSQL databases using certificates can
|
||||
> be found
|
||||
> [here](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-CLIENTCERT).
|
||||
More information on connecting to PostgreSQL databases using certificates can
|
||||
be found in the [PostgreSQL documentation](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-CLIENTCERT).
|
||||
|
||||
@@ -57,8 +57,8 @@ persistent environment from your main device, a tablet, or your phone.
|
||||
|
||||
## Windows
|
||||
|
||||
> **Important:** If you plan to use the built-in PostgreSQL database, ensure
|
||||
> that the
|
||||
> [!IMPORTANT]
|
||||
> If you plan to use the built-in PostgreSQL database, ensure that the
|
||||
> [Visual C++ Runtime](https://learn.microsoft.com/en-US/cpp/windows/latest-supported-vc-redist#latest-microsoft-visual-c-redistributable-version)
|
||||
> is installed.
|
||||
|
||||
|
||||
@@ -53,9 +53,9 @@
|
||||
|
||||
## Create DNS provider credentials
|
||||
|
||||
> This example assumes you're using CloudFlare as your DNS provider. For other
|
||||
> providers, refer to the
|
||||
> [CertBot documentation](https://eff-certbot.readthedocs.io/en/stable/using.html#dns-plugins).
|
||||
This example assumes you're using CloudFlare as your DNS provider. For other
|
||||
providers, refer to the
|
||||
[CertBot documentation](https://eff-certbot.readthedocs.io/en/stable/using.html#dns-plugins).
|
||||
|
||||
1. Create an API token for the DNS provider you're using: e.g.
|
||||
[CloudFlare](https://developers.cloudflare.com/fundamentals/api/get-started/create-token)
|
||||
@@ -92,8 +92,8 @@
|
||||
|
||||
## Configure Apache
|
||||
|
||||
> This example assumes Coder is running locally on `127.0.0.1:3000` and that
|
||||
> you're using `coder.example.com` as your subdomain.
|
||||
This example assumes Coder is running locally on `127.0.0.1:3000` and that
|
||||
you're using `coder.example.com` as your subdomain.
|
||||
|
||||
1. Create Apache configuration for Coder:
|
||||
|
||||
|
||||
@@ -36,8 +36,8 @@
|
||||
|
||||
## Adding Coder deployment subdomain
|
||||
|
||||
> This example assumes Coder is running locally on `127.0.0.1:3000` and that
|
||||
> you're using `coder.example.com` as your subdomain.
|
||||
This example assumes Coder is running locally on `127.0.0.1:3000` and that
|
||||
you're using `coder.example.com` as your subdomain.
|
||||
|
||||
1. Create NGINX configuration for this app:
|
||||
|
||||
@@ -60,9 +60,9 @@
|
||||
|
||||
## Create DNS provider credentials
|
||||
|
||||
> This example assumes you're using CloudFlare as your DNS provider. For other
|
||||
> providers, refer to the
|
||||
> [CertBot documentation](https://eff-certbot.readthedocs.io/en/stable/using.html#dns-plugins).
|
||||
This example assumes you're using CloudFlare as your DNS provider. For other
|
||||
providers, refer to the
|
||||
[CertBot documentation](https://eff-certbot.readthedocs.io/en/stable/using.html#dns-plugins).
|
||||
|
||||
1. Create an API token for the DNS provider you're using: e.g.
|
||||
[CloudFlare](https://developers.cloudflare.com/fundamentals/api/get-started/create-token)
|
||||
|
||||
@@ -23,7 +23,8 @@ treated as such.**
|
||||
|
||||
A brief overview of all files contained in the bundle is provided below:
|
||||
|
||||
> Note: detailed descriptions of all the information available in the bundle is
|
||||
> [!NOTE]
|
||||
> Detailed descriptions of all the information available in the bundle is
|
||||
> out of scope, as support bundles are primarily intended for internal use.
|
||||
|
||||
| Filename | Description |
|
||||
@@ -61,7 +62,8 @@ A brief overview of all files contained in the bundle is provided below:
|
||||
2. Ensure you have the Coder CLI installed on a local machine. See
|
||||
[installation](../install/index.md) for steps on how to do this.
|
||||
|
||||
> Note: It is recommended to generate a support bundle from a location
|
||||
> [!NOTE]
|
||||
> It is recommended to generate a support bundle from a location
|
||||
> experiencing workspace connectivity issues.
|
||||
|
||||
3. Ensure you are [logged in](../reference/cli/login.md#login) to your Coder
|
||||
@@ -80,7 +82,8 @@ A brief overview of all files contained in the bundle is provided below:
|
||||
6. Coder staff will provide you a link where you can upload the bundle along
|
||||
with any other necessary supporting files.
|
||||
|
||||
> Note: It is helpful to leave an informative message regarding the nature of
|
||||
> [!NOTE]
|
||||
> It is helpful to leave an informative message regarding the nature of
|
||||
> supporting files.
|
||||
|
||||
Coder support will then review the information you provided and respond to you
|
||||
|
||||
@@ -21,6 +21,7 @@ Coder can provision all Terraform modules, resources, and properties. The Coder
|
||||
server essentially runs a `terraform apply` every time a workspace is created,
|
||||
started, or stopped.
|
||||
|
||||
> [!TIP]
|
||||
> Haven't written Terraform before? Check out Hashicorp's
|
||||
> [Getting Started Guides](https://developer.hashicorp.com/terraform/tutorials).
|
||||
|
||||
|
||||
Reference in New Issue
Block a user