Skip to content

Commit c84ee2e

Browse files
authored
Add Getting Started Doc (coder#458)
1 parent c34e045 commit c84ee2e

File tree

2 files changed

+107
-0
lines changed

2 files changed

+107
-0
lines changed

getting-started.md

+104
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,104 @@
1+
---
2+
title: "Getting started"
3+
description: Get started with Coder.
4+
icon: '<svg xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" version="1.1" viewBox="0 0 16 16" width="16" xml:space="preserve"><path d="M1 2a1 1 0 0 1 1-1h11a1 1 0 0 1 1 1v1h.5A1.5 1.5 0 0 1 16 4.5v7a1.5 1.5 0 0 1-1.5 1.5h-.55a2.5 2.5 0 0 1-2.45 2h-8A2.5 2.5 0 0 1 1 12.5V2zm13 10h.5a.5.5 0 0 0 .5-.5v-7a.5.5 0 0 0-.5-.5H14v8z"/></svg>'
5+
---
6+
7+
We’re excited for you to be part of the growing community of Coder users, and we
8+
wanted to provide an onboarding guide to ensure you have a great experience.
9+
Coder’s [documentation is publicly editable](https://github.com/cdr/docs),
10+
so please feel free to contribute and provide feedback as you desire.
11+
12+
## Setup and deploy Coder
13+
14+
To get started with Coder, you’ll need to [deploy Coder](./setup/index.md) to a
15+
Kubernetes cluster. We have documentation to help you [create a
16+
cluster](./setup/kubernetes/index.md) if needed. Once you have a cluster, you
17+
can [install Coder via Helm](./setup/installation.md).
18+
19+
## Configure Coder
20+
21+
After you deploy Coder, you’ll need to [upload your license
22+
file](./setup/configuration.md) before you can configure the application (you
23+
can get a trial license for free [here](https://coder.com/trial)). Once logged
24+
in, you’ll be able to access the [administration management](./admin/index.md)
25+
menu to set up things such as [access
26+
controls](./admin/access-control/index.md) with OpenID Connect (OIDC),
27+
[create organizations](./admin/organizations.md), and create an OAuth app for
28+
your users to [connect to your Git provider](./admin/git.md).
29+
30+
At a minimum, you’ll want to ensure you [add a container
31+
registry](./admin/registries/index.md) for your development environments to pull
32+
from, and [import an image](./images/importing.md) with the tools your
33+
developers need. You can [create custom
34+
images](./guides/customization/custom-workspace.md) for your developer
35+
workspaces as well.
36+
37+
## Provision users
38+
39+
With some base configuration done, you’ll want to allow your developers to begin
40+
using Coder. You can manually create and invite users, or you can set up OpenID
41+
Connect (OIDC) with [Azure AD](./guides/admin/oidc-azuread.md) or
42+
[Okta](./guides/admin/oidc-okta.md). If you are using another Identity Provider
43+
(IdP), the process should be very similar. With OIDC configured, Coder will
44+
automatically create a user and add them to the [default
45+
organization](./admin/organizations.md) when a developer logs in for the first
46+
time.
47+
48+
## Automate
49+
50+
Coder has a [command-line (CLI) tool](./cli/index.md) that you and your
51+
developers may be interested in using to interact with Coder. The CLI is
52+
completely [open-sourced](https://github.com/cdr/coder-cli), and we always
53+
welcome contributions. Additionally, Coder has a [public API](./guides/api.md)
54+
that you can use to automate various tasks through code.
55+
56+
## Connect local IDEs
57+
58+
While Coder supports a [variety of IDEs in the
59+
browser](https://coder.com/docs/coder/v1.20/workspaces/editors), such as VSCode
60+
and the JetBrains product suite, some developers may want to use their local
61+
installation of these tools or other IDEs with Coder. By leveraging the [Coder
62+
CLI](./cli/index.md), developers will be able to [connect their
63+
terminal](./cli/remote-terminal.md) to the remote environment’s terminal, and
64+
enable [file sync](./cli/file-sync.md) to have their local directory’s tree sync
65+
with the remote file system.
66+
67+
## Maintain and update
68+
69+
Coder maintains a public [changelog](./changelog/index.md) and [release
70+
calendar](https://coder.com/release-calendar.ical) to help you stay in the know
71+
on features, bug fixes, security updates, and breaking changes that are coming.
72+
Coder releases are available on the third Wednesday of each month, and patch
73+
releases are published and available as needed.
74+
75+
## Interact with Support
76+
77+
Coder’s standard support is included with your license. You can reach us at
78+
[support@coder.com](mailto:support@coder.com), and one of our engineers will be
79+
able to assist. Please include any relevant logs, error messages, or
80+
screenshots.
81+
82+
Coder also has a [public community Slack](https://cdr.co/join-community) you can
83+
join if you’d like.
84+
85+
Finally, Coder offers premium support through Coder Escalation Services, which
86+
provides a faster response Service-Level Agreement (SLA). Speak to your account
87+
executive if you’re interested in this option.
88+
89+
## Additional information
90+
91+
There are a variety of ways to follow Coder to stay up-to-date on company
92+
updates, whitepapers, blog posts, and more.
93+
94+
- [Coder Blog](https://coder.com/blog)
95+
- [Videos about Coder](https://coder.com/resources/videos)
96+
- [Whitepapers](https://coder.com/resources/whitepapers)
97+
- Social media accounts such as
98+
[LinkedIn](https://www.linkedin.com/company/coderhq),
99+
[YouTube](https://www.youtube.com/channel/UCWexK_ECcUU3vEIdb-VYkfw),
100+
[Twitter](https://twitter.com/coderhq), and others
101+
102+
Finally, we encourage you to look through the various
103+
[Guides](./guides/index.md) in our public documentation, as it contains more
104+
detailed information on specific use cases and topics.

manifest.json

+3
Original file line numberDiff line numberDiff line change
@@ -15,6 +15,9 @@
1515
}
1616
]
1717
},
18+
{
19+
"path": "getting-started.md"
20+
},
1821
{
1922
"path": "./workspaces/index.md",
2023
"children": [

0 commit comments

Comments
 (0)