Stephen Kirby
53806906ea
chore(docs): tweak replica verbiage on reference architectures ( #16076 )
...
A seller noted that the `/` operator made the node count hard to
interpret.
2025-01-14 16:26:10 -06:00
Danielle Maywood
009069cd47
feat: allow notification templates to be disabled by default ( #16093 )
...
Change as part of https://github.com/coder/coder/pull/16071
It has been decided that we want to be able to have some notification
templates be disabled _by default_
https://github.com/coder/coder/pull/16071#issuecomment-2580757061 .
This adds a new column (`enabled_by_default`) to
`notification_templates` that defaults to `TRUE`. It also modifies the
`inhibit_enqueue_if_disabled` function to reject notifications for
templates that have `enabled_by_default = FALSE` with the user not
explicitly enabling it.
2025-01-13 15:01:47 +00:00
Gregory McCue
08dd2ab4cc
docs: fix typo in prometheus.md ( #16091 )
...
Fixes small `scrape_config` typo in `prometheus.md`
2025-01-10 12:02:25 -05:00
Edward Angert
ee1829ba71
docs: update external auth to better explain process ( #16027 )
...
- adds to @ChristopherJTrent's PR #15970
> Adds more information on how to add external auth, including
docker-compose and docker CLI examples and terraform code for template
integration.
- general edits and improvements to the external-auth doc
[preview](https://coder.com/docs/@15970-external-auth-update/admin/external-auth )
---------
Co-authored-by: Christopher Trent <ChristopherJTrent@outlook.com >
Co-authored-by: Muhammad Atif Ali <me@matifali.dev >
2025-01-07 15:10:16 -05:00
Charlie Voiselle
4e0963966d
docs: markdown fixes and edits ( #15527 )
...
- **docs: improve admonition for need to add useHttpPath**
- **docs: fix list item nesting**
- **docs: fix list item nesting**
- **docs: improve admonition for authentication**
- **docs: tidy and update vault guide**
- **docs: improve admonitions**
- **docs: improve admonitions**
- **docs: content edits, reference links to make copy easier to read**
previews:
- <https://coder.com/docs/@fix-guides-list-numbers/admin/external-auth >
-
<https://coder.com/docs/@fix-guides-list-numbers/admin/integrations/island >
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: EdwardAngert <EdwardAngert@users.noreply.github.com >
2025-01-03 14:13:46 -05:00
Muhammad Atif Ali
94f5d52fdc
chore: adopt markdownlint and markdown-table-formatter for *.md ( #15831 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2025-01-03 13:12:59 +00:00
Steven Masley
73ec6b2635
chore: audit log entries for all idp sync changes ( #15919 )
2025-01-02 15:02:04 -06:00
Spike Curtis
18600d3620
docs: add note about TLD and wildcards ( #16008 )
...
Adds docs to hopefully help others avoid https://github.com/coder/coder/discussions/15708
2025-01-02 14:01:28 +04:00
Steven Masley
c9eb06eb97
chore: remove dead link to azure docs issues ( #15982 )
2024-12-31 16:17:59 +05:00
Cian Johnston
26b1f1c3a3
chore(docs/admin/infrastructure): call out and link to awsiamrds auth for aws rds ( #15955 )
...
Call out AWS IAM RDS db auth and clarify URL encoding requirement in postgres URL
2024-12-24 12:22:40 +00:00
Phorcys
7be96bbb09
chore(docs): clarify that variables be edited through the web UI ( #15799 )
2024-12-18 15:55:19 +00:00
Edward Angert
bcb15aab42
docs: add context for wireguard in places referencing tailscale ( #15901 )
...
> We do not use Tailscale (product) but instead import Tailscale OSS
libraries which has some nice ways of handling Wireguard. We also use
Tailscale's logo in our architecture, but calling it only `Tailscale`
seems to throw people off when they're considering Coder and how it
works.
I've left it wherever it seems to make sense (such as when we talk about
[DERP](https://coder.com/docs/admin/networking#relayed-connections )),
and sprinkled some `Wireguard` and `websocket/HTTPS` where I could
2024-12-17 15:13:12 -05:00
Edward Angert
1eba4c08cb
docs: add beta back to orgs ( #15902 )
...
I merged https://github.com/coder/coder/pull/15888/ too early.
This PR incorporates @matifali 's edit suggestions
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 13:37:26 -05:00
Edward Angert
21cc6f77fe
docs: move premium and enterprise badges from heading to info in admonition ( #15774 )
...
closes https://github.com/coder/coder.com/issues/666
[preview](https://coder.com/docs/@666-unheading-premium/user-guides/workspace-scheduling#autostop-requirement )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 18:20:01 +00:00
Edward Angert
468ffd9919
docs: copy edit the organizations doc and add link to best practices ( #15888 )
...
[preview](https://coder.com/docs/@orgs-edit-202412/admin/users/organizations )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-17 10:44:21 +05:00
Joobi S B
e191d9650c
feat: support created_at filter for the GET /users endpoint ( #15633 )
...
Closes https://github.com/coder/coder/issues/12747
We support these filters currently:
https://coder.com/docs/v2/latest/admin/users#user-filtering , adding
`created_at` filter as well.
2024-12-17 15:24:54 +11:00
Edward Angert
74f07ec9ae
docs: add new security doc to best practices section ( #15805 )
...
[preview](https://coder.com/docs/@bp-security/tutorials/best-practices/security-best-practices )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Spike Curtis <spike@coder.com >
2024-12-16 20:47:38 +00:00
Eric Paulsen
2ec2e8ae6d
docs: add istio docs ( #15733 )
...
closes https://github.com/coder/coder/issues/11821
2024-12-11 17:48:28 +00:00
Edward Angert
5e7199233c
docs: add cli steps for org sync ( #15673 )
...
[preview](https://coder.com/docs/@15431-docs-org-sync/admin/users/idp-sync#organization-sync-premium )
---------
Co-authored-by: EdwardAngert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-12-10 11:09:41 -05:00
Phorcys
069655ace9
chore: unify template naming ( #15757 )
...
This PR changes template names and docs to follow the
`<provider>-<os/whatever>` format for all templates.
I've decided not to split this into multiple PRs because I'd have to
edit rebase the other PRs once one of them gets merged, this should be
relatively low-impact anyways.
This aligns with our goals to make templates more user-friendly.
Closes #15754
2024-12-05 22:37:25 +05:00
bartekgatzcoder
3b1131ca01
fix(docs): fix a typo in extending-templates ( #15744 )
...
It's -> its
2024-12-04 10:17:39 -05:00
Danielle Maywood
e21a301682
fix: make GetWorkspacesEligibleForTransition return even less false positives ( #15594 )
...
Relates to https://github.com/coder/coder/issues/15082
Further to https://github.com/coder/coder/pull/15429 , this reduces the
amount of false-positives returned by the 'is eligible for autostart'
part of the query. We achieve this by calculating the 'next start at'
time of the workspace, storing it in the database, and using it in our
`GetWorkspacesEligibleForTransition` query.
The prior implementation of the 'is eligible for autostart' query would
return _all_ workspaces that at some point in the future _might_ be
eligible for autostart. This now ensures we only return workspaces that
_should_ be eligible for autostart.
We also now pass `currentTick` instead of `t` to the
`GetWorkspacesEligibleForTransition` query as otherwise we'll have one
round of workspaces that are skipped by `isEligibleForTransition` due to
`currentTick` being a truncated version of `t`.
2024-12-02 21:02:36 +00:00
Edward Angert
b06d833012
docs: improve dev containers documentation for user start-up ( #15458 )
...
- [x] TODO: verify and expand [What is an image, template, devcontainer,
or
workspace](https://coder.com/docs/@bp-dev-containers/admin#what-is-an-image-template-devcontainer-or-workspace )
- [x] TODO: verify and expand `## Add a devcontainer template to Coder`
- [x] TODO: verify and expand `## Layer and image caching`
- [x] TODO: link to and edit
[dotfiles](https://coder.com/docs/user-guides/workspace-dotfiles ) doc
- [x] TODO:
https://github.com/coder/coder/pull/15458/files#diff-be0dd9ff983020129c7a94c628a0fc4a397a9bbc8b5eec92ec38f4b8c83fe167R10
[preview](https://coder.com/docs/@bp-dev-containers/admin/templates/managing-templates/devcontainers )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Cian Johnston <cian@coder.com >
Co-authored-by: Ben Potter <ben@coder.com >
Co-authored-by: Edward Angert <2408959-EdwardAngert@users.noreply.gitlab.com >
Co-authored-by: Muhammad Atif Ali <atif@coder.com >
2024-12-02 09:19:04 -08:00
Cian Johnston
694b4e0d3e
feat(dogfood/contents): set coder_workspace_tags in dogfood template ( #15653 )
...
* Sets `coder_workspace_tags` on our dogfood template to target new tagged provisioner deployment added in coder/dogfood#103
2024-12-02 09:17:40 +00:00
Hugo Dutka
b830c05e3e
chore: track usage of built-in example templates ( #15671 )
...
Addresses https://github.com/coder/nexus/issues/99 .
Changes:
- Save the id of the built-in example template used to create a template
version in the database
- Include the example id in telemetry
2024-11-27 20:01:08 +01:00
Cian Johnston
e550365e35
chore(docs): update documentation for coder_workspace_tags ( #15620 )
...
Adds documentation relating to
https://github.com/coder/coder/issues/15087 and
https://github.com/coder/coder/issues/15427
See also: https://github.com/coder/coder/pull/15578
2024-11-25 21:01:18 +00:00
Muhammad Atif Ali
dcbcf6740c
docs: add guide for CI/CD template testing ( #15528 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-11-20 23:58:51 +05:00
Spike Curtis
9e63caf593
docs: add crypto_keys to list of dbcrypt fields ( #15602 )
...
closes: https://github.com/coder/internal/issues/220
Updates docs that talk about what db fields we encrypt. We've recently added `crypto_keys.secret` to the list, but didn't add it to the docs.
2024-11-20 11:03:46 +04:00
Danielle Maywood
576e1f48fe
feat!: allow disabling notifications ( #15509 )
...
Resolves https://github.com/coder/coder/issues/15513
Disables notifications when both `$CODER_NOTIFICATIONS_WEBHOOK_ENDPOINT` and `$CODER_EMAIL_SMARTHOST` are unset.
Breaking change: `$CODER_EMAIL_SMARTHOST` is no longer set by default as `localhost:587`, meaning any deployments that make use of this default value will need to add it back.
---------
Co-authored-by: Danny Kopping <danny@coder.com >
Co-authored-by: Mathias Fredriksson <mafredri@gmail.com >
2024-11-19 15:05:12 +00:00
Cian Johnston
55dccae5a3
chore(docs): document how to correctly override list(string) parameters ( #15497 )
...
- Adds documentation for how to correctly hold --parameter with list(string)
- Adds tests for the aforementioned documented correct finger positions for --parameter list(string)
2024-11-13 15:41:36 +00:00
Muhammad Atif Ali
6ff302b740
docs: add Docker to provider authentication docs ( #15494 )
...
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-11-13 15:40:41 +00:00
Ethan
fa69d1ca74
ci: reenable link checker & fix broken links ( #15489 )
...
Follow-up on #15484 .
2024-11-13 16:04:10 +11:00
Edward Angert
eff07a2db0
docs: clarify admin email telemetry ( #15485 )
...
add a note to the telemtery doc that explains that we do collect the
admin email
https://coder.com/docs/@telemetry-clarification/admin/setup/telemetry#what-we-collect
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-12 11:24:13 -05:00
Mathias Fredriksson
78b4967571
docs: fix mention of incorrect env var to enable/disable telemetry ( #15467 )
2024-11-11 11:12:39 +00:00
Edward Angert
e688ff723b
docs: add deploy id to license doc ( #15415 )
...
resolves #15414
adds a section to licensing doc to show where to find the deployment ID
[preview](https://coder.com/docs/@15414-deploy-id/admin/licensing#find-your-deployment-id )
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-07 21:54:11 -08:00
Cian Johnston
9f05b192b4
chore(docs): fix inconsistencies in external provisioner docs ( #15416 )
...
This PR:
- Updates the table in `docs/admin/provisioners.md` to include highlight
multi-org changes
- Updates the instructions for the provisionerd helm chart when using
provisioner keys
---------
Co-authored-by: Ben Potter <ben@coder.com >
2024-11-07 13:28:53 +00:00
Ethan
6e18742ad3
ci: replace unmaintained markdown link checker ( #15424 )
...
The old one was flaking a bunch and blocking PRs. This is the one
recommended by the maintainer of the old.
2024-11-07 22:30:43 +11:00
Benjamin Peinhardt
040e5cf9f3
docs: provide example regexes to properly escape . characters ( #14983 )
2024-11-03 10:01:06 -06:00
Edward Angert
1f93b80e09
chore: fix docs/admin links and upgrade notice ( #15043 )
...
- Update links to /docs/admin to match the new structure
- TODO: remove the release string from the "upgrade available"
instructions link
- [x]
https://github.com/coder/coder/blob/update-upgrade-config-links/cli/server.go#L646

---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-11-01 19:43:51 +00:00
Stephen Kirby
399c830b51
chore(docs): add info on new build timings in docs ( #15310 )
...
Adds information on workspace build timings in workspace lifecycle and
template troubleshooting docs.
2024-11-01 12:17:50 -05:00
Stephen Kirby
e9fbfcc45b
chore(docs): include custom roles examples and mention of password reset ( #15294 )
...
Added example custom roles for admin inspiration, mention of headless
authentication use case, and user-activated password reset.
2024-10-30 11:41:52 -05:00
Danielle Maywood
823a2ea22e
chore(cli): drop 'notification' prefix for configuring email auth ( #15270 )
...
Closes https://github.com/coder/coder/issues/14644
2024-10-30 10:06:10 +00:00
Stephen Kirby
25738388d5
chore(docs): add documentation on custom roles ( #15280 )
...
These docs were overwritten in the restructure merge.
2024-10-29 20:58:26 -05:00
Danielle Maywood
4e20eea9e6
chore: remove unused 'must_reset_password' column ( #15265 )
...
Closes https://github.com/coder/internal/issues/153
Remove the 'must_reset_password' as it was introduced for use in the
"forgot password?" flow but never used.
2024-10-29 09:57:40 +00:00
Stephen Kirby
971388762c
chore(docs): change mentions of enterprise to premium ( #15258 )
...
Matches our latest licensing verbiage.
2024-10-28 15:56:51 -05:00
Edward Angert
007f0a35a4
fix: adjust instances of Github to GitHub ( #15203 )
...
s/Github/GitHub
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-28 07:43:30 -04:00
Edward Angert
ed5da65a54
chore(docs): add Quickstart doc to tutorials ( #14744 )
...
New doc to get users up and running quickly
preview: https://coder.com/docs/@quickstart-guide/tutorials/quickstart
## To Do
- [x] update or remove Codium steps
- [x] add to sidebar
- [x] add to README and others as needed
- [x] reference https://github.com/coder/coder/pull/11946 and the
discussion to influence this PR
closes https://github.com/coder/internal/issues/107
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
Co-authored-by: Muhammad Atif Ali <atif@coder.com >
2024-10-23 11:31:29 -04:00
Edward Angert
d7baa49d6d
docs: add primary to wsproxy ls ( #15185 )
...
Add primary to `coder wsproxy ls` results in
<https://coder.com/docs/admin/networking/workspace-proxies#step-2-deploy-the-proxy >
---------
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-23 11:15:55 -04:00
Edward Angert
20a9e9bdfb
chore(docs): remove workspace proxy map ( #15070 )
...
remove workspace proxy map
- replace later with another image or diagram
Co-authored-by: EdwardAngert <17991901+EdwardAngert@users.noreply.github.com >
2024-10-23 11:15:32 -04:00
Cian Johnston
84f0cf215f
chore(docs): update external provisioners helm docs ( #15155 )
...
Closes https://github.com/coder/coder/issues/14985
Updates external provisioner documentation to show steps for using
provisioner keys via Helm:
---------
Co-authored-by: Edward Angert <EdwardAngert@users.noreply.github.com >
2024-10-23 09:25:53 +01:00