Skip to content

Commit 690c791

Browse files
committed
Merge branch 'main' into embeddeddb
2 parents 7fd3560 + bb4ecd7 commit 690c791

File tree

5 files changed

+30
-17
lines changed

5 files changed

+30
-17
lines changed

cli/server.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -134,7 +134,7 @@ func server() *cobra.Command {
134134

135135
config := createConfig(cmd)
136136
// Only use built-in if PostgreSQL URL isn't specified!
137-
if postgresURL == "" {
137+
if !inMemoryDatabase && postgresURL == "" {
138138
var closeFunc func() error
139139
cmd.Printf("Using built-in PostgreSQL (%s)\n", config.PostgresPath())
140140
postgresURL, closeFunc, err = startBuiltinPostgres(cmd.Context(), config, logger)

cli/server_test.go

Lines changed: 1 addition & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -67,21 +67,13 @@ func TestServer(t *testing.T) {
6767
cancelFunc()
6868
require.ErrorIs(t, <-errC, context.Canceled)
6969
})
70-
t.Run("NoPostgres", func(t *testing.T) {
71-
t.Parallel()
72-
ctx, cancelFunc := context.WithCancel(context.Background())
73-
defer cancelFunc()
74-
root, _ := clitest.New(t, "server", "--address", ":0")
75-
err := root.ExecuteContext(ctx)
76-
require.Error(t, err)
77-
})
7870
t.Run("BuiltinPostgres", func(t *testing.T) {
7971
t.Parallel()
8072
if testing.Short() {
8173
t.SkipNow()
8274
}
8375
ctx, cancelFunc := context.WithCancel(context.Background())
84-
root, cfg := clitest.New(t, "server", "--address", ":0", "--postgres-builtin")
76+
root, cfg := clitest.New(t, "server", "--address", ":0")
8577
errC := make(chan error)
8678
go func() {
8779
errC <- root.ExecuteContext(ctx)

docs/images/code-server.png

169 KB
Loading

docs/install.md

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ This article walks you through the various ways of installing and deploying Code
44

55
## install.sh
66

7-
The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/main/install.sh) for Linux and macOS. The install script
7+
The easiest way to install Coder is to use our [install script](https://github.com/coder/coder/blob/main/install.sh) for Linux and macOS. The install script
88
attempts to use the system package manager detection-reference if possible.
99

1010
You can preview what occurs during the install process:
@@ -113,3 +113,8 @@ We publish self-contained .zip and .tar.gz archives in [GitHub releases](https:/
113113
# Requires a PostgreSQL instance and external access URL
114114
coder server --postgres-url <url> --access-url <url>
115115
```
116+
117+
## Next steps
118+
119+
Once you've installed and started Coder, see the [quickstart](./quickstart.md)
120+
for instructions on creating your first template and workspace.

docs/quickstart.md

Lines changed: 22 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,10 @@
11
# Quickstart
22

3-
This guide will walk you through creating your first template and workspace. If you haven't already installed `coder`, do that first [here](./install.md).
3+
This guide will walk you through creating your first template and workspace.
4+
5+
## Prerequisites
6+
7+
Please [install Coder](./install.md) before proceeding with the steps outlined in this article.
48

59
## Creating your first template and workspace
610

@@ -10,8 +14,13 @@ In a new terminal window, run the following to copy a sample template:
1014
coder templates init
1115
```
1216

13-
Follow the CLI instructions to modify and create the template specific for your
14-
usage (e.g., a template to **Develop in Linux on Google Cloud**).
17+
Follow the CLI instructions to select an example that you can modify for your
18+
specific usage (e.g., a template to **Develop code-server in Docker**):
19+
20+
1. Navigate into your new templates folder and create your first template using
21+
the provided command (e.g., `cd ./docker-code-server && coder templates create`)
22+
23+
1. Answer the CLI prompts; when done, confirm that you want to create your template.
1524

1625
Create a workspace using your template:
1726

@@ -25,13 +34,20 @@ Connect to your workspace via SSH:
2534
coder ssh <workspaceName>
2635
```
2736

37+
You can also access your workspace using the **access URL** you provided when
38+
deploying Coder (if you're using a temporary deployment and you opted to use
39+
Coder's tunnel, use the access URL you were provided). Log in with the admin
40+
credentials provided to you by Coder.
41+
42+
![Coder Web UI with code-server](images/code-server.png)
43+
2844
## Modifying templates
2945

30-
If needed, you can edit the Terraform template using a sample template:
46+
You can edit the Terraform template as follows:
3147

3248
```sh
3349
coder templates init
34-
cd gcp-linux/
50+
cd gcp-linux # modify this line as needed to access the template
3551
vim main.tf
36-
coder templates update gcp-linux
52+
coder templates update gcp-linux # updates the template
3753
```

0 commit comments

Comments
 (0)