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