- Notifications
You must be signed in to change notification settings - Fork1k
chore: simplify readme#12639
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to ourterms of service andprivacy statement. We’ll occasionally send you account related emails.
Already on GitHub?Sign in to your account
Merged
Uh oh!
There was an error while loading.Please reload this page.
Merged
chore: simplify readme#12639
Changes fromall commits
Commits
Show all changes
2 commits Select commitHold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Jump to
Jump to file
Failed to load files.
Loading
Uh oh!
There was an error while loading.Please reload this page.
Diff view
Diff view
There are no files selected for viewing
29 changes: 11 additions & 18 deletionsREADME.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -23,7 +23,6 @@ | ||
[Quickstart](#quickstart) | [Docs](https://coder.com/docs) | [Why Coder](https://coder.com/why) | [Enterprise](https://coder.com/docs/v2/latest/enterprise) | ||
[](https://discord.gg/coder) | ||
[](https://github.com/coder/coder/releases/latest) | ||
[](https://pkg.go.dev/github.com/coder/coder) | ||
[](https://goreportcard.com/report/github.com/coder/coder) | ||
@@ -53,8 +52,8 @@ curl -L https://coder.com/install.sh | sh | ||
# Start the Coder server (caches data in ~/.cache/coder) | ||
coder server | ||
# Navigate to http://localhost:3000 to create your initial user, | ||
#create a Docker template, and provision a workspace | ||
``` | ||
## Install | ||
@@ -68,11 +67,11 @@ Releases. | ||
curl -L https://coder.com/install.sh | sh | ||
``` | ||
You can run the install script with `--dry-run` to see the commands that will be used to install without executing them. Run the install script with `--help` foradditional flags. | ||
> See [install](https://coder.com/docs/v2/latest/install) for additional methods. | ||
Once installed, you can start a production deployment with a single command: | ||
```shell | ||
# Automatically sets up an external access URL on *.try.coder.app | ||
@@ -82,8 +81,6 @@ coder server | ||
coder server --postgres-url <url> --access-url <url> | ||
``` | ||
Use `coder --help` to get a list of flags and environment variables. Use our [install guides](https://coder.com/docs/v2/latest/install) for a full walkthrough. | ||
## Documentation | ||
@@ -96,30 +93,26 @@ Browse our docs [here](https://coder.com/docs/v2) or visit a specific section be | ||
- [**Administration**](https://coder.com/docs/v2/latest/admin): Learn how to operate Coder | ||
- [**Enterprise**](https://coder.com/docs/v2/latest/enterprise): Learn about our paid features built for large teams | ||
## Support | ||
Feel free to [open an issue](https://github.com/coder/coder/issues/new) if you have questions, run into bugs, or have a feature request. | ||
matifali marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
[Join our Discord](https://discord.gg/coder) to provide feedback on in-progress features, and chat with the community using Coder! | ||
##Integrations | ||
We are always working on new integrations. Feel free to open an issue to request an integration. Contributions are welcome in any official or community repositories. | ||
### Official | ||
- [**VS Code Extension**](https://marketplace.visualstudio.com/items?itemName=coder.coder-remote): Open any Coder workspace in VS Code with a single click | ||
- [**JetBrains Gateway Extension**](https://plugins.jetbrains.com/plugin/19620-coder): Open any Coder workspace in JetBrains Gateway with a single click | ||
- [**Dev Container Builder**](https://github.com/coder/envbuilder): Build development environments using `devcontainer.json` on Docker, Kubernetes, and OpenShift | ||
kylecarbs marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
- [**Module Registry**](https://registry.coder.com): Extend development environments with common use-cases | ||
- [**Kubernetes Log Stream**](https://github.com/coder/coder-logstream-kube): Stream Kubernetes Pod events to the Coder startup logs | ||
- [**Self-Hosted VS Code Extension Marketplace**](https://github.com/coder/code-marketplace): A private extension marketplace that works in restricted or airgapped networks integrating with [code-server](https://github.com/coder/code-server). | ||
### Community | ||
- [**Provision Coder with Terraform**](https://github.com/ElliotG/coder-oss-tf): Provision Coder on Google GKE, Azure AKS, AWS EKS, DigitalOcean DOKS, IBMCloud K8s, OVHCloud K8s, and Scaleway K8s Kapsule with Terraform | ||
- [**Coder Template GitHub Action**](https://github.com/marketplace/actions/update-coder-template): A GitHub Action that updates Coder templates |
4 changes: 0 additions & 4 deletionsexamples/templates/README.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -13,7 +13,3 @@ git clone https://github.com/coder/coder | ||
cd examples/templates/aws-linux | ||
coder templates push | ||
``` | ||
kylecarbs marked this conversation as resolved. Show resolvedHide resolvedUh oh!There was an error while loading.Please reload this page. | ||
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.