-
Notifications
You must be signed in to change notification settings - Fork 76
/
manifest.json
1817 lines (1817 loc) · 64.2 KB
/
manifest.json
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
{
"versions": [
"v1.44",
"v1.43",
"v1.42",
"v1.41",
"v1.40",
"v1.39",
"v1.38",
"v1.37",
"v1.36",
"v1.35",
"v1.34"
],
"routes": [
{
"path": "./index.md",
"icon_path": "./assets/images/icons/home.svg",
"children": [
{
"path": "about.md",
"title": "About",
"description": "Learn about Coder, our mission, and why to choose us."
},
{
"path": "comparison.md",
"title": "Comparison",
"description": "Get an overview of our features."
},
{
"path": "feedback.md",
"title": "Feedback"
}
],
"title": "Home",
"description": "Explore our guides and examples to get started with Coder."
},
{
"path": "getting-started/index.md",
"icon_path": "./assets/images/icons/get-started.svg",
"children": [
{
"path": "getting-started/docker.md",
"title": "Coder for Docker",
"description": "Get started with Coder for Docker as a developer."
},
{
"path": "getting-started/admin.md",
"title": "Administrators",
"description": "Getting started with Coder as an administrator."
},
{
"path": "getting-started/data-scientists.md",
"title": "Data scientists",
"description": "Get started with Coder as a data scientist."
},
{
"path": "getting-started/developers.md",
"title": "Developers",
"description": "Get started with Coder as a developer."
},
{
"path": "getting-started/intellij.md",
"title": "IntelliJ",
"description": "Get started with Coder as an IntelliJ user."
},
{
"path": "getting-started/pycharm.md",
"title": "PyCharm",
"description": "Get started with Coder as a PyCharm user."
}
],
"title": "Getting started",
"description": "Get started with Coder."
},
{
"path": "./workspaces/index.md",
"icon_path": "./assets/images/icons/workspaces.svg",
"children": [
{
"path": "./workspaces/create.md",
"title": "Create a workspace",
"description": "Learn how to create and develop in a workspace."
},
{
"path": "./workspaces/lifecycle.md",
"title": "Lifecycle",
"description": "Learn about the workspace lifecycle."
},
{
"path": "./workspaces/autostart.md",
"title": "Auto-start",
"description": "Learn how to configure automated workspace rebuilds."
},
{
"path": "./workspaces/devurls.md",
"title": "Dev URLs",
"description": "Learn how to access HTTP services running inside your workspace."
},
{
"path": "./workspaces/cvms.md",
"title": "Docker in workspaces",
"description": "Learn how to run Docker securely inside your workspace."
},
{
"path": "./workspaces/editors.md",
"title": "Editors and IDEs",
"description": "Learn how to connect your favorite editors and IDEs to your remote workspace."
},
{
"path": "./workspaces/variables.md",
"title": "Environment variables",
"description": "Learn how to work with CODER_* environment variables inside workspaces."
},
{
"path": "./workspaces/personalization.md",
"title": "Personalization",
"description": "Learn how to personalize your workspace to augment its base image."
},
{
"path": "./workspaces/preferences.md",
"title": "Preferences",
"description": "Learn how to manage your Coder account preferences."
},
{
"path": "./workspaces/pwa.md",
"title": "Progressive web apps",
"description": "Learn how to install the editor PWAs for a native IDE-like browser editing experience."
},
{
"path": "./workspaces/ssh.md",
"title": "SSH access",
"description": "Learn how to configure SSH access to your workspaces."
},
{
"path": "./workspaces/vs-code-extensions.md",
"title": "VS Code extensions",
"description": "Learn how to add and use VS Code extensions with your workspace."
},
{
"path": "./workspaces/applications.md",
"title": "Workspace applications",
"description": "Learn how to access web apps running in your workspace.",
"state": "beta"
},
{
"path": "./workspaces/workspace-params.md",
"title": "Workspace parameters",
"description": "Learn about each parameter available during workspace creation."
},
{
"path": "./workspaces/workspace-templates/index.md",
"children": [
{
"path": "./workspaces/workspace-templates/templates.md",
"title": "Workspace templates",
"description": "Learn how to write a template for creating workspaces.",
"state": "alpha"
},
{
"path": "./workspaces/workspace-templates/code-completion.md",
"title": "Workspace template code completion",
"description": "Learn how to use code completion when creating workspace templates.",
"state": "alpha"
}
],
"title": "Workspace templates",
"description": "Learn how to describe workspace configuration as code.",
"state": "alpha"
}
],
"title": "Workspaces",
"description": "Learn about development workspaces in Coder."
},
{
"path": "./images/index.md",
"icon_path": "./assets/images/icons/images.svg",
"children": [
{
"path": "./images/configure.md",
"title": "Configure script",
"description": "Learn how to configure Coder's workspace startup behavior."
},
{
"path": "./images/writing.md",
"title": "Custom image creation",
"description": "Learn how to write custom images for use with Coder."
},
{
"path": "./images/deprecating.md",
"title": "Deprecate and Decommission",
"description": "Learn how to deprecate an image and decommission a tag."
},
{
"path": "./images/embed-button.md",
"title": "Embeddable button",
"description": "Learn how to embed an \"Open in Coder\" Button in Your Repo"
},
{
"path": "./images/importing.md",
"title": "Import",
"description": "Learn how to import images to use in Coder."
},
{
"path": "./images/structure.md",
"title": "Structure",
"description": "Learn how to best structure image specifications for use inside your organization."
},
{
"path": "./images/tags.md",
"title": "Tags",
"description": "Learn how to manage image versions inside Coder."
},
{
"path": "./images/tls-certificates.md",
"title": "TLS certificates",
"description": "Learn how to add TLS certificates to Coder images"
}
],
"title": "Images",
"description": "Learn about reproducibility in Coder."
},
{
"path": "./cli/index.md",
"icon_path": "./assets/images/icons/terminal.svg",
"children": [
{
"path": "./cli/installation.md",
"title": "Installation and setup",
"description": "Learn how to install and configure the Coder CLI."
},
{
"path": "./cli/remote-terminal.md",
"title": "Remote terminal",
"description": "Learn how to use the Coder CLI to access your workspace."
},
{
"path": "./cli/file-sync.md",
"title": "File sync",
"description": "Learn how to sync files between Coder and your local IDE."
},
{
"path": "./cli/managing-workspaces.md",
"title": "Workspace management",
"description": "See example usages of the CLI for personal workspace management."
},
{
"path": "./cli/reference/coder.md",
"title": "Reference",
"description": "CLI reference",
"children": [
{
"path": "./cli/reference/coder_completion.md",
"title": "coder completion"
},
{
"path": "./cli/reference/coder_config-ssh.md",
"title": "coder config-ssh"
},
{
"path": "./cli/reference/coder_images.md",
"title": "coder images",
"children": [
{
"path": "./cli/reference/coder_images_ls.md",
"title": "coder images ls"
}
]
},
{
"path": "./cli/reference/coder_login.md",
"title": "coder login"
},
{
"path": "./cli/reference/coder_logout.md",
"title": "coder logout"
},
{
"path": "./cli/reference/coder_satellites.md",
"title": "coder satellites",
"children": [
{
"path": "./cli/reference/coder_satellites_create.md",
"title": "coder satellites create"
},
{
"path": "./cli/reference/coder_satellites_ls.md",
"title": "coder satellites ls"
},
{
"path": "./cli/reference/coder_satellites_rm.md",
"title": "coder satellites rm"
}
]
},
{
"path": "./cli/reference/coder_ssh.md",
"title": "coder ssh"
},
{
"path": "./cli/reference/coder_sync.md",
"title": "coder sync"
},
{
"path": "./cli/reference/coder_tokens.md",
"title": "coder tokens",
"children": [
{
"path": "./cli/reference/coder_tokens_create.md",
"title": "coder tokens create"
},
{
"path": "./cli/reference/coder_tokens_ls.md",
"title": "coder tokens ls"
},
{
"path": "./cli/reference/coder_tokens_regen.md",
"title": "coder tokens regen"
},
{
"path": "./cli/reference/coder_tokens_rm.md",
"title": "coder tokens rm"
}
]
},
{
"path": "./cli/reference/coder_tunnel.md",
"title": "coder tunnel"
},
{
"path": "./cli/reference/coder_update.md",
"title": "coder update"
},
{
"path": "./cli/reference/coder_urls.md",
"title": "coder urls",
"children": [
{
"path": "./cli/reference/coder_urls_create.md",
"title": "coder urls create"
},
{
"path": "./cli/reference/coder_urls_ls.md",
"title": "coder urls ls"
},
{
"path": "./cli/reference/coder_urls_rm.md",
"title": "coder urls rm"
}
]
},
{
"path": "./cli/reference/coder_users.md",
"title": "coder users",
"children": [
{
"path": "./cli/reference/coder_users_ls.md",
"title": "coder users ls"
}
]
},
{
"path": "./cli/reference/coder_workspaces.md",
"title": "coder workspaces",
"children": [
{
"path": "./cli/reference/coder_workspaces_create-from-config.md",
"title": "coder workspaces create-from-config"
},
{
"path": "./cli/reference/coder_workspaces_create.md",
"title": "coder workspaces create"
},
{
"path": "./cli/reference/coder_workspaces_edit-from-config.md",
"title": "coder workspaces edit-from-config"
},
{
"path": "./cli/reference/coder_workspaces_edit.md",
"title": "coder workspaces edit"
},
{
"path": "./cli/reference/coder_workspaces_ls.md",
"title": "coder workspaces ls"
},
{
"path": "./cli/reference/coder_workspaces_ping.md",
"title": "coder workspaces ping"
},
{
"path": "./cli/reference/coder_workspaces_policy-template.md",
"title": "coder workspaces policy-template"
},
{
"path": "./cli/reference/coder_workspaces_rebuild.md",
"title": "coder workspaces rebuild"
},
{
"path": "./cli/reference/coder_workspaces_rm.md",
"title": "coder workspaces rm"
},
{
"path": "./cli/reference/coder_workspaces_stop.md",
"title": "coder workspaces stop"
},
{
"path": "./cli/reference/coder_workspaces_watch-build.md",
"title": "coder workspaces watch-build"
}
]
}
]
}
],
"title": "Command line"
},
{
"path": "./setup/index.md",
"icon_path": "./assets/images/icons/wrench.svg",
"children": [
{
"path": "./setup/architecture.md",
"title": "Architecture",
"description": "Learn about the technical architecture of the Coder platform."
},
{
"path": "./setup/requirements.md",
"title": "System Requirements",
"description": "Learn about the prerequisite infrastructure requirements."
},
{
"path": "./setup/kubernetes/index.md",
"children": [
{
"path": "./setup/kubernetes/k3s.md",
"title": "K3s",
"description": "Set up K3s on an Ubuntu machine to deploy Coder."
},
{
"path": "./setup/kubernetes/aws.md",
"title": "Amazon Elastic Kubernetes Service",
"description": "Learn how to set up an Amazon EKS cluster for your Coder deployment."
},
{
"path": "./setup/kubernetes/azure.md",
"title": "Azure Kubernetes Service",
"description": "Learn how to set up an AKS cluster for your Coder deployment."
},
{
"path": "./setup/kubernetes/google.md",
"title": "Google Kubernetes Engine",
"description": "Learn how to set up a GKE cluster for your Coder deployment."
},
{
"path": "./setup/kubernetes/openshift.md",
"title": "Red Hat OpenShift",
"description": "Learn about deploying Coder in OpenShift Container Platform"
},
{
"path": "./setup/kubernetes/rke.md",
"title": "Rancher Kubernetes Engine",
"description": "Learn how to setup a Rancher cluster for your Coder deployment"
}
],
"title": "Kubernetes",
"description": "Learn how to set up a Kubernetes cluster compatible with Coder."
},
{
"path": "./setup/installation.md",
"title": "Installation",
"description": "Learn how to install Coder onto your infrastructure."
},
{
"path": "./setup/configuration.md",
"title": "Configuration",
"description": "Learn how to configure a fresh Coder installation."
},
{
"path": "./setup/scaling.md",
"title": "Scaling Coder",
"description": "Learn about best practices to properly scale Coder to meet developer and workspace needs."
},
{
"path": "./setup/air-gapped/index.md",
"children": [
{
"path": "./setup/air-gapped/infrastructure.md",
"title": "Network setup",
"description": "Learn how to set up a network for air-gapped Coder deployment."
},
{
"path": "./setup/air-gapped/offline-docs.md",
"title": "Offline documentation",
"description": "Learn how to use Coder's embedded documentation."
}
],
"title": "Air-gapped deployment",
"description": "Learn how to set up an air-gapped Coder deployment."
},
{
"path": "./setup/coder-for-docker/index.md",
"children": [
{
"path": "./setup/coder-for-docker/local.md",
"title": "Local deployment",
"description": "Learn how to run Coder with Docker locally."
},
{
"path": "./setup/coder-for-docker/postgres.md",
"title": "External database setup",
"description": "Learn how to set up an external Postgres database for use with C4D."
},
{
"path": "./setup/coder-for-docker/upgrade.md",
"title": "Upgrade",
"description": "Learn how to upgrade your Coder for Docker deployment."
}
],
"title": "Coder for Docker",
"description": "Learn how to run Coder with Docker."
},
{
"path": "./setup/upgrade/index.md",
"children": [
{
"path": "./setup/upgrade/considerations.md",
"title": "Update considerations",
"description": "Learn how to update your Coder deployment."
}
],
"title": "Upgrade",
"description": "Learn how to upgrade your Coder deployment."
}
],
"title": "Setup",
"description": "Learn how to set up a Coder instance."
},
{
"path": "./admin/index.md",
"icon_path": "./assets/images/icons/gear.svg",
"children": [
{
"path": "./admin/access-control/index.md",
"children": [
{
"path": "./admin/access-control/manage.md",
"title": "Authentication management",
"description": "Learn how to manage Coder authentication."
},
{
"path": "./admin/access-control/organizations.md",
"title": "Organization roles",
"description": "Learn how to manage organization roles."
},
{
"path": "./admin/access-control/users/index.md",
"children": [
{
"path": "./admin/access-control/users/user-roles.md",
"title": "User roles",
"description": "Learn about Coder's user roles and the privileges they offer."
},
{
"path": "./admin/access-control/users/password-reset.md",
"title": "Password reset",
"description": "Learn how to reset Coder user passwords."
}
],
"title": "User management",
"description": "Learn how to add, delete and manage Coder users."
}
],
"title": "Access control",
"description": "Learn how to change how Coder users sign in."
},
{
"path": "./admin/organizations/index.md",
"children": [
{
"path": "./admin/organizations/manage.md",
"title": "Org management",
"description": "Learn about managing organizations."
}
],
"title": "Organizations",
"description": "Learn about Coder organizations."
},
{
"path": "./admin/registries/index.md",
"children": [
{
"path": "./admin/registries/default-registry.md",
"title": "Default registry",
"description": "Learn how to work with Coder's default registry."
},
{
"path": "./admin/registries/ecr.md",
"title": "Amazon Elastic Container Registry",
"description": "Add a private Amazon ECR to Coder."
},
{
"path": "./admin/registries/azure.md",
"title": "Azure Container Registry",
"description": "Add a Microsoft Azure Container Registry (ACR) to Coder."
},
{
"path": "./admin/registries/gcr.md",
"title": "Google Container Registry",
"description": "Add the Google Container Registry to Coder."
}
],
"title": "Registries",
"description": "Learn how to hook into Docker Registries."
},
{
"path": "./admin/satellites/index.md",
"children": [
{
"path": "./admin/satellites/management.md",
"title": "Manage satellites",
"description": "Learn how to manage a satellite."
},
{
"path": "./admin/satellites/migration.md",
"title": "Migrate to satellite deployments",
"description": "Learn how to migrate workspace providers deployed before v1.21 to satellites."
},
{
"path": "./admin/satellites/global-access-url.md",
"title": "Global access URL configuration",
"description": "Learn how to configure your primary and satellite deployments so that they\nshare an access URL.\n",
"state": "alpha"
}
],
"title": "Satellites",
"description": "Learn about satellite deployments to reduce global latency."
},
{
"path": "./admin/workspace-management/index.md",
"children": [
{
"path": "./admin/workspace-management/cvms/index.md",
"children": [
{
"path": "./admin/workspace-management/cvms/cluster-setup.md",
"title": "Cluster setup",
"description": "Learn how to set up K8s clusters capable of supporting CVMs."
},
{
"path": "./admin/workspace-management/cvms/images.md",
"title": "Images",
"description": "Learn how to work with images for CVM-enabled workspaces."
},
{
"path": "./admin/workspace-management/cvms/management.md",
"title": "Management",
"description": "Learn how to enable CVMs."
}
],
"title": "Docker in workspaces",
"description": "Learn about supporting Docker inside workspaces."
},
{
"path": "./admin/workspace-management/extensions.md",
"title": "Extensions",
"description": "Learn how to configure the code-server extension marketplace."
},
{
"path": "./admin/workspace-management/gpu-acceleration.md",
"title": "GPU acceleration",
"description": "Learn how to use GPUs with workspaces."
},
{
"path": "./admin/workspace-management/installing-jetbrains.md",
"title": "IDE installation",
"description": "Learn how to install IDEs in images."
},
{
"path": "./admin/workspace-management/memory-overprovisioning.md",
"title": "Memory provisioning",
"description": "Learn how to provision memory requests from workspaces."
},
{
"path": "./admin/workspace-management/cpu-provisioning.md",
"title": "CPU provisioning",
"description": "Learn how to set the CPU provisioning ratio."
},
{
"path": "./admin/workspace-management/self-contained-builds.md",
"title": "Self-contained workspace builds",
"description": "Learn how to toggle self-contained workspace builds."
},
{
"path": "./admin/workspace-management/shutdown.md",
"title": "Shutdown",
"description": "Learn how to configure workspace auto-off behavior."
},
{
"path": "./admin/workspace-management/ssh-access.md",
"title": "SSH configuration",
"description": "Learn how to configure SSH access to Coder workspaces."
},
{
"path": "./admin/workspace-management/limits.md",
"title": "Workspace limits",
"description": "Learn how to limit the number of workspaces users can create."
},
{
"path": "./admin/workspace-management/process-logging.md",
"title": "Workspace process logging",
"description": "Learn how to enable workspace process logging for your deployment."
}
],
"title": "Workspace management",
"description": "Learn how to manage workspaces from an admin level."
},
{
"path": "./admin/workspace-providers/index.md",
"children": [
{
"path": "./admin/workspace-providers/deployment/index.md",
"children": [
{
"path": "./admin/workspace-providers/deployment/docker.md",
"title": "Docker",
"description": "Learn how to deploy a workspace provider to a Docker instance.",
"state": "alpha"
},
{
"path": "./admin/workspace-providers/deployment/ec2.md",
"title": "EC2",
"description": "Learn how to deploy a workspace provider to an EC2 instance.",
"state": "alpha"
},
{
"path": "./admin/workspace-providers/deployment/kubernetes.md",
"title": "Kubernetes",
"description": "Learn how to deploy a workspace provider to a Kubernetes cluster."
}
],
"title": "Deployment",
"description": "Learn how to deploy a workspace provider to a cluster."
},
{
"path": "./admin/workspace-providers/management.md",
"title": "Workspace provider management",
"description": "Learn how to manage a workspace provider."
}
],
"title": "Workspace providers",
"description": "Learn how workspace providers can improve the developer experience."
},
{
"path": "./admin/access-url.md",
"title": "Access URL",
"description": "Learn how to set the access URL."
},
{
"path": "./admin/account-dormancy.md",
"title": "Account dormancy",
"description": "Learn how to manage the lifecycle of dormant user accounts."
},
{
"path": "./admin/appearance.md",
"title": "Appearance",
"description": "Learn how to augment the dashboard appearance."
},
{
"path": "./admin/audit.md",
"title": "Audit",
"description": "Learn how Coder audits user and admin actions."
},
{
"path": "./admin/security.md",
"title": "Security",
"description": "Learn about Coder's security options."
},
{
"path": "./admin/devurls.md",
"title": "Dev URLs",
"description": "Learn how to configure dev URL support for a Coder deployment."
},
{
"path": "./admin/stun.md",
"title": "Direct workspace connections",
"description": "Learn how to enable direct connections to workspaces."
},
{
"path": "./admin/shell.md",
"title": "Fallback shell",
"description": "Learn how to enable fallback shell support for Kubernetes."
},
{
"path": "./admin/git.md",
"title": "Git integration",
"description": "Learn how to integrate with a Git provider to authenticate workspaces."
},
{
"path": "./admin/prometheus.md",
"title": "Prometheus integration",
"description": "Learn how to configure Prometheus with Coder."
},
{
"path": "./admin/licensing.md",
"title": "Licensing",
"description": "Learn how to manage the license for your Coder deployment."
},
{
"path": "./admin/telemetry.md",
"title": "Telemetry",
"description": "Learn what usage telemetry Coder collects."
},
{
"path": "./admin/templates.md",
"title": "Templates",
"description": "Learn how to manage your workspace templates."
},
{
"path": "./admin/metrics.md",
"title": "Usage metrics",
"description": "Learn how to track usage of your Coder deployment."
}
],
"title": "Admin"
},
{
"path": "./guides/index.md",
"icon_path": "./assets/images/icons/guides.svg",
"navigable": true,
"children": [
{
"path": "./guides/admin/index.md",
"children": [
{
"path": "./guides/admin/resources.md",
"title": "Compute resources",
"description": "Learn the unique compute resource management capabilities in Coder."
},
{
"path": "./guides/admin/timescale-migration.md",
"title": "Database migration",
"description": "Learn how to migrate data from Coder's built-in database."
},
{
"path": "./guides/admin/awsrds.md",
"title": "AWS RDS with IAM credentials",
"description": "Learn how to connect Coder to an RDS database using IAM."
},
{
"path": "./guides/admin/disable-downloads.md",
"title": "File download disabling",
"description": "Learn how to disable file downloading in Coder."
},
{
"path": "./guides/admin/helm-charts.md",
"title": "Helm charts",
"description": "Learn how to modify configuration values in Helm charts."
},
{
"path": "./guides/admin/image-tag-names.md",
"title": "Image tag names",
"description": "Learn about image tag naming conventions and recommendations for use."
},
{
"path": "./guides/admin/logging.md",
"title": "Logging",
"description": "Learn how to set up logging for your Coder deployment."
},
{
"path": "./guides/admin/nfs.md",
"title": "NFS file mounting",
"description": "Learn how to mount NFS file shares onto Coder workspaces."
},
{
"path": "./guides/admin/oidc-azuread.md",
"title": "OpenID Connect with Azure AD",
"description": "Learn how to use Azure's Active Directory SSO with Coder."
},
{
"path": "./guides/admin/oidc-adfs.md",
"title": "OpenID Connect with Active Directory Federation Services (ADFS)",
"description": "Learn how to use Azure's Active Directory Federation Services (ADFS) SSO with Coder."
},
{
"path": "./guides/admin/oidc-google.md",
"title": "OpenID Connect with Google",
"description": "Learn how to use Google SSO with Coder."
},
{
"path": "./guides/admin/oidc-okta.md",
"title": "OpenID Connect with Okta",
"description": "Learn how to use Okta SSO with Coder."
},
{
"path": "./guides/admin/shared-security.md",
"title": "Shared security responsibility",
"description": "Learn how Coder and its users carry security-related responsibilities."
},
{
"path": "./guides/admin/storage.md",
"title": "Storage",
"description": "Learn about storage in workspaces."
},
{
"path": "./guides/admin/usage-monitoring.md",
"title": "Usage monitoring",
"description": "Learn how to monitor Coder's compute usage."
},
{
"path": "./guides/admin/wp-cli.md",
"title": "Workspace provider provisioning via CLI",
"description": "Learn how to provision a workspace provider using the Coder CLI."
}
],
"title": "Admin",
"description": "Learn about admin tasks for Coder."
},
{
"path": "./guides/customization/index.md",
"children": [
{
"path": "./guides/customization/gitconfig.md",
"title": "Git configuration",
"description": "Learn how to configure Git in Coder."
},
{
"path": "./guides/customization/gpg-forwarding.md",
"title": "GPG forwarding",
"description": "Learn how to configure GPG agent forwarding Coder."
},
{
"path": "./guides/customization/macos-keybinding.md",
"title": "macOS keybindings",
"description": "Learn how to use macOS keybindings with JetBrains IDEs."
},
{
"path": "./guides/customization/multiple-jetbrains-ides.md",
"title": "Multiple JetBrains instances configuration",
"description": "Learn how to run multiple instances of JetBrains IDEs in Coder."
},
{
"path": "./guides/customization/node.md",
"title": "Node.js Projects",
"description": "Learn how to create custom images for Node.js projects."
},
{
"path": "./guides/customization/tailscale.md",
"title": "Tailscale",
"description": "Learn how to use Tailscale in your Coder workspace."
},
{
"path": "./guides/customization/vnc.md",
"title": "VNC",
"description": "Learn how to set up a VNC in Coder."
}
],
"title": "Customization",
"description": "Learn about tasks related to customizing Coder."
},
{
"path": "./guides/deployments/index.md",
"children": [
{
"path": "./guides/deployments/archive-install.md",
"title": "Coder installation from an archive",
"description": "Learn how to install Coder from an archive"
},
{
"path": "./guides/deployments/artifactory.md",
"title": "JFrog Artifactory",
"description": "Learn how to use Artifactory to host container images in Coder."
},
{
"path": "./guides/deployments/code-server.md",
"title": "Managed code-server Workspaces",
"description": "Learn how Coder can improve your code-server deployment on Kubernetes."
},
{
"path": "./guides/deployments/podman.md",
"title": "Podman",
"description": "Learn how to run Podman in Coder."
},
{
"path": "./guides/deployments/postgres.md",
"title": "PostgreSQL",
"description": "Learn how connect Coder to an external postgreSQL database."
},
{
"path": "./guides/deployments/proxy.md",
"title": "Proxies",
"description": "Learn how to configure forward and reverse proxies for Coder."
},
{
"path": "./guides/deployments/keycloak.md",
"title": "SAML 2.0 identity brokering",
"description": "Learn how broker JumpCloud SAML 2.0 logins to Coder using Keycloak."
},
{
"path": "./guides/deployments/teardown.md",
"title": "Teardown",