You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/dogfood/index.md
+28-28Lines changed: 28 additions & 28 deletions
Original file line number
Diff line number
Diff line change
@@ -2,37 +2,37 @@
2
2
3
3
This guide explains how to [dogfood](https://www.techopedia.com/definition/30784/dogfooding) coder for employees at Coder.
4
4
5
-
## How to
5
+
## How to
6
6
7
7
The following explains how to do certain things related to dogfooding.
8
8
9
9
### Dogfood using Coder's Deployment
10
10
11
-
1. Go to [https://dev.coder.com/templates/coder-ts](https://dev.coder.com/templates/coder-ts)
12
-
1. If you don't have an account, sign in with GitHub
13
-
2. If you see a dialog/pop-up, hit "Cancel" (this is because of Rippling)
11
+
1. Go to [https://dev.coder.com/templates/coder-ts](https://dev.coder.com/templates/coder-ts)
12
+
1. If you don't have an account, sign in with GitHub
13
+
2. If you see a dialog/pop-up, hit "Cancel" (this is because of Rippling)
14
14
2. Create a workspace
15
15
3.[Connect with your favorite IDE](https://coder.com/docs/coder-oss/latest/ides)
16
-
4. Clone the repo: `git clone git@github.com:coder/coder.git`
16
+
4. Clone the repo: `git clone git@github.com:coder/coder.git`
17
17
5. Follow the [contributing guide](https://coder.com/docs/coder-oss/latest/CONTRIBUTING)
18
18
19
19
### Run Coder in your Coder Workspace
20
20
21
-
1. Clone the Git repo `[https://github.com/coder/coder](https://github.com/coder/coder)` and `cd` into it
22
-
2. Run `sudo apt update` and then `sudo apt install -y netcat`
21
+
1.Clone the Git repo `[https://github.com/coder/coder](https://github.com/coder/coder)` and `cd` into it
22
+
2.Run `sudo apt update` and then `sudo apt install -y netcat`
23
23
- skip this step if using the `coder` template
24
-
3. Run `make bin`
25
-
24
+
3.Run `make bin`
25
+
26
26
<aside>
27
27
💡 If you run into the following error:
28
-
28
+
29
29
```js
30
30
pg_dump: server version:13.7 (Debian 13.7-1.pgdg110+1); pg_dump version:11.16 (Ubuntu 11.16-1.pgdg20.04+1)
31
31
pg_dump: aborting because of server version mismatch
32
32
```
33
-
33
+
34
34
Don’t fret! This is a known issue. To get around it:
35
-
35
+
36
36
1. Add `export DB_FROM=coderdb` to your `.bashrc` (make sure you `source ~/.bashrc`)
37
37
2. Run `sudo service postgresql start`
38
38
3. Run `sudo -u postgres psql` (this will open the PostgreSQL CLI)
@@ -42,24 +42,22 @@ The following explains how to do certain things related to dogfooding.
42
42
7. Run `exit` to exit the PostgreSQL terminal
43
43
8. Try `make bin` again.
44
44
</aside>
45
-
46
-
4. Run `./scripts/develop.sh` which will start *two* separate processes:
45
+
46
+
4.Run `./scripts/develop.sh` which will start _two_ separate processes:
47
47
1.`[http://localhost:3000](http://localhost:3000)` — backend API server 👈 Backend devs will want to talk to this
48
48
2.`[http://localhost:8080](http://localhost:8080)` — Node.js dev server 👈 Frontend devs will want to talk to this
49
-
50
-
5. Ensure that you’re logged in:`./scripts/coder-dev.sh list` — should return no workspace. Ifthis returns an error, double-check the output of running `scripts/develop.sh`.
51
-
6.A template named `docker-amd64` (or `docker-arm64`if you’re on ARM) will have automatically been created foryou. If you just want to create a workspace quickly, you can run `./scripts/coder-dev.sh create myworkspace -t docker-amd64` and this will get you going quickly!
52
-
7. To create your own template, you can do:`./scripts/coder-dev.sh templates init` and choose your preferred option.
53
-
For example, choosing “Develop in Docker” will create a newfolder`docker` that contains the bare bones for starting a Docker workspace template.
54
-
Then, enter the folder that was just created and customize as you wish.
55
-
56
-
<aside>
57
-
💡 **For all Docker templates:**
58
-
This step depends on whether you are developing on a Coder v1 workspace, versus a Coder v2 workspace, versus a VM, versus locally. In any case, check the output of the command `docker context ls` to determine where your Docker daemon is listening. Then open `./docker/main.tf` and check inside the block `provider "docker"` that the variable `"host"` is set correctly.
59
-
60
-
</aside>
49
+
5. Ensure that you’re logged in:`./scripts/coder-dev.sh list` — should return no workspace. Ifthis returns an error, double-check the output of running `scripts/develop.sh`.
50
+
6.A template named `docker-amd64` (or `docker-arm64`if you’re on ARM) will have automatically been created foryou. If you just want to create a workspace quickly, you can run `./scripts/coder-dev.sh create myworkspace -t docker-amd64` and this will get you going quickly!
51
+
7. To create your own template, you can do:`./scripts/coder-dev.sh templates init` and choose your preferred option.
52
+
For example, choosing “Develop in Docker” will create a newfolder`docker` that contains the bare bones for starting a Docker workspace template.
53
+
Then, enter the folder that was just created and customize as you wish.
54
+
<aside>
55
+
💡 **For all Docker templates:**
56
+
This step depends on whether you are developing on a Coder v1 workspace, versus a Coder v2 workspace, versus a VM, versus locally. In any case, check the output of the command `docker context ls` to determine where your Docker daemon is listening. Then open `./docker/main.tf` and check inside the block `provider "docker"` that the variable `"host"` is set correctly.
57
+
58
+
</aside>
61
59
62
-
## Troubleshooting
60
+
## Troubleshooting
63
61
64
62
### My Docker containers keep failing and I have no idea what's going on!
65
63
@@ -86,9 +84,11 @@ Run 'coder create --help' for usage.
86
84
```
87
85
88
86
Check the output of `docker ps -a`
87
+
89
88
- If you see a container with the status `Exited` run `docker logs <container name>` and see what the issue with the container output is
0 commit comments