selfhosted
/
coder
mirror of https://github.com/coder/coder.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity
coder/README.md

92 lines
4.7 KiB
Markdown
Raw Normal View History

feat: Update README with highlights and getting started guide (#627)
2022-03-28 20:21:00 +00:00
# Coder
chore: Initial GHA workflow (#1) This implements an initial GitHub Actions workflow for us - to be run on PRs and on `main` commits. This just implements a really simple `style/fmt` check - running `prettier` on the `README.md`. I assumed we'll stick with using a top-level `Makefile` for commands like in `m` and `link` - but open to alternatives, too! Since I was adding a `package.json` and `node_modules` for this, I realized we were missing `.gitignore`s, so I added some a subset of the ignore files from `coder/m`
2022-01-04 02:54:27 +00:00
feat: initial docs pages (#1107) * docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * fix typos * Update docs/about.md Co-authored-by: Joe Previte <jjprevite@gmail.com> * remove line breaks between bullets * rename variables to parameters * reduce limits * chore: edit text * revert some changes, fix footnotes Co-authored-by: Katie Horne <katie@coder.com> Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-04-26 17:10:50 +00:00
[!["GitHub
Discussions"](https://img.shields.io/badge/%20GitHub-%20Discussions-gray.svg?longCache=true&logo=github&colorB=purple)](https://github.com/coder/coder/discussions)
[!["Join us on
chore: change Slack to Discord link (#1573)
2022-05-18 21:14:31 +00:00
Discord"](https://img.shields.io/badge/join-us%20on%20Discord-gray.svg?longCache=true&logo=discord&colorB=purple)](https://discord.gg/coder)
feat: initial docs pages (#1107) * docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * fix typos * Update docs/about.md Co-authored-by: Joe Previte <jjprevite@gmail.com> * remove line breaks between bullets * rename variables to parameters * reduce limits * chore: edit text * revert some changes, fix footnotes Co-authored-by: Katie Horne <katie@coder.com> Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-04-26 17:10:50 +00:00
[![Twitter
Follow](https://img.shields.io/twitter/follow/CoderHQ?label=%40CoderHQ&style=social)](https://twitter.com/coderhq)
[![codecov](https://codecov.io/gh/coder/coder/branch/main/graph/badge.svg?token=TNLW3OAP6G)](https://codecov.io/gh/coder/coder)
chore: Initial README
2022-01-03 18:52:07 +00:00
docs: slim down readme (#2140) * docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
2022-06-08 15:37:03 +00:00
Coder creates remote development machines so your team can develop from anywhere.
chore: Initial GHA workflow (#1) This implements an initial GitHub Actions workflow for us - to be run on PRs and on `main` commits. This just implements a really simple `style/fmt` check - running `prettier` on the `README.md`. I assumed we'll stick with using a top-level `Makefile` for commands like in `m` and `link` - but open to alternatives, too! Since I was adding a `package.json` and `node_modules` for this, I realized we were missing `.gitignore`s, so I added some a subset of the ignore files from `coder/m`
2022-01-04 02:54:27 +00:00
Rewrite README for launch (#1731)
2022-05-25 00:40:57 +00:00
<p align="center">
<img src="./docs/images/hero-image.png">
</p>
feat: add screenshot to readme (#1313) * feat: add screenshot to readme * change
2022-05-06 01:09:27 +00:00
Rewrite README for launch (#1731)
2022-05-25 00:40:57 +00:00
**Manage less**
docs: rephrase value statement in README (#1711)
2022-05-24 17:59:20 +00:00
Rewrite README for launch (#1731)
2022-05-25 00:40:57 +00:00
- Ensure your entire team is using the same tools and resources
- Rollout critical updates to your developers with one command
- Automatically shut down expensive cloud resources
- Keep your source code and data behind your firewall
docs: slim down readme (#2140) * docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
2022-06-08 15:37:03 +00:00
**Code more**
Rewrite README for launch (#1731)
2022-05-25 00:40:57 +00:00
docs: slim down readme (#2140) * docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
2022-06-08 15:37:03 +00:00
- Build and test faster
- Leveraging cloud CPUs, RAM, network speeds, etc.
- Access your environment from any place on any client (even an iPad)
- Onboard instantly then stay up to date continuously
Rewrite README for launch (#1731)
2022-05-25 00:40:57 +00:00
docs: slim down readme (#2140) * docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
2022-06-08 15:37:03 +00:00
## Getting Started
chore: Initial README
2022-01-03 18:52:07 +00:00
docs: slim down readme (#2140) * docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
2022-06-08 15:37:03 +00:00
> **Note**:
> Coder is in an alpha state. [Report issues here](https://github.com/coder/coder/issues/new).
chore: Add documentation of our phased approach to the UX (#15)
2022-01-11 21:05:49 +00:00
chore: update link to go to Coder docs instead of GitHub (#2330)
2022-06-15 14:16:43 +00:00
There are a few ways to install Coder: [install script](https://coder.com/docs/coder-oss/latest/install#installsh) (macOS, Linux), [docker-compose](https://coder.com/docs/coder-oss/latest/install#docker-compose), or [manually](https://coder.com/docs/coder-oss/latest/install#manual) via the latest release (macOS, Windows, and Linux).
refactor: Add install script for coder CLI (#243) This adds a `make install` target that copies the CLI and other coder binaries to `$GOPATH/bin` Intended to be helpful for developers who aren't familiar with `go` or the directory structure, in running `coder` CLI locally.
2022-02-11 04:32:00 +00:00
feat: one-line install script (#1924) * feat: one-line install script * remove homebrew support * remove arch linux * use proper filename for packages * fix variable format * fix systemd instructions * fixes to standalone script * fix missing var bugs * fix standalone install * fix for MacOS * format * fix armv7 assets and zips * remove windows * update install docs * support external sources with shellcheck * shfmt * add external sources to GitHub action & unfold * change wording * first template docs * default to /usr/local instead * add option for binary name
2022-06-01 19:15:09 +00:00
If you use the install script, you can preview what occurs during the install process:
chore: Run 'yarn install' when building (#215) I noticed when showing the development flow to a few engineers, there was one awkward step - you have to `cd site` and run `yarn install`, and then come back to root to `make build` or `./develop.sh` This just adds `yarn install` as part of `make build` and `./develop.sh` - so whichever one is run first will start work.
2022-02-09 21:46:46 +00:00
feat: one-line install script (#1924) * feat: one-line install script * remove homebrew support * remove arch linux * use proper filename for packages * fix variable format * fix systemd instructions * fixes to standalone script * fix missing var bugs * fix standalone install * fix for MacOS * format * fix armv7 assets and zips * remove windows * update install docs * support external sources with shellcheck * shfmt * add external sources to GitHub action & unfold * change wording * first template docs * default to /usr/local instead * add option for binary name
2022-06-01 19:15:09 +00:00
```sh
curl -fsSL https://coder.com/install.sh | sh -s -- --dry-run
```
docs: Add additional commands (#455) This adds a couple of missing pieces to the docs: - More info about `./develop.sh` - Steps to run the built coder binary manually - Starting the server - Logging in - Creating a project I attempted to keep them relatively agnostic so they wouldn't be out of date immediately when https://github.com/coder/coder/pull/422 is merged
2022-03-16 03:55:21 +00:00
feat: one-line install script (#1924) * feat: one-line install script * remove homebrew support * remove arch linux * use proper filename for packages * fix variable format * fix systemd instructions * fixes to standalone script * fix missing var bugs * fix standalone install * fix for MacOS * format * fix armv7 assets and zips * remove windows * update install docs * support external sources with shellcheck * shfmt * add external sources to GitHub action & unfold * change wording * first template docs * default to /usr/local instead * add option for binary name
2022-06-01 19:15:09 +00:00
To install, run:
docs: Add additional commands (#455) This adds a couple of missing pieces to the docs: - More info about `./develop.sh` - Steps to run the built coder binary manually - Starting the server - Logging in - Creating a project I attempted to keep them relatively agnostic so they wouldn't be out of date immediately when https://github.com/coder/coder/pull/422 is merged
2022-03-16 03:55:21 +00:00
feat: one-line install script (#1924) * feat: one-line install script * remove homebrew support * remove arch linux * use proper filename for packages * fix variable format * fix systemd instructions * fixes to standalone script * fix missing var bugs * fix standalone install * fix for MacOS * format * fix armv7 assets and zips * remove windows * update install docs * support external sources with shellcheck * shfmt * add external sources to GitHub action & unfold * change wording * first template docs * default to /usr/local instead * add option for binary name
2022-06-01 19:15:09 +00:00
```sh
curl -fsSL https://coder.com/install.sh | sh
```
docs: Add additional commands (#455) This adds a couple of missing pieces to the docs: - More info about `./develop.sh` - Steps to run the built coder binary manually - Starting the server - Logging in - Creating a project I attempted to keep them relatively agnostic so they wouldn't be out of date immediately when https://github.com/coder/coder/pull/422 is merged
2022-03-16 03:55:21 +00:00
feat: Add built-in PostgreSQL for simple production setup (#2345) * feat: Add built-in PostgreSQL for simple production setup Fixes #2321. * Use fork of embedded-postgres for cache path
2022-06-15 21:02:18 +00:00
Once installed, you can start a production deployment with a single command:
chore: clarify install options in README (#1844) * chore: clarify install options in README * clarify the path is an example, not a requirement * Update README.md Co-authored-by: Katie Horne <katie@coder.com> * Update README.md Co-authored-by: Katie Horne <katie@coder.com> * Update README.md Co-authored-by: Katie Horne <katie@coder.com> * Update README.md Co-authored-by: Katie Horne <katie@coder.com> * Update README.md Co-authored-by: Katie Horne <katie@coder.com> Co-authored-by: Katie Horne <katie@coder.com>
2022-05-27 18:10:54 +00:00
feat: one-line install script (#1924) * feat: one-line install script * remove homebrew support * remove arch linux * use proper filename for packages * fix variable format * fix systemd instructions * fixes to standalone script * fix missing var bugs * fix standalone install * fix for MacOS * format * fix armv7 assets and zips * remove windows * update install docs * support external sources with shellcheck * shfmt * add external sources to GitHub action & unfold * change wording * first template docs * default to /usr/local instead * add option for binary name
2022-06-01 19:15:09 +00:00
```sh
feat: Add built-in PostgreSQL for simple production setup (#2345) * feat: Add built-in PostgreSQL for simple production setup Fixes #2321. * Use fork of embedded-postgres for cache path
2022-06-15 21:02:18 +00:00
# Automatically sets up an external access URL on *.try.coder.app
coder server --tunnel
# Requires a PostgreSQL instance and external access URL
coder server --postgres-url <url> --access-url <url>
feat: one-line install script (#1924) * feat: one-line install script * remove homebrew support * remove arch linux * use proper filename for packages * fix variable format * fix systemd instructions * fixes to standalone script * fix missing var bugs * fix standalone install * fix for MacOS * format * fix armv7 assets and zips * remove windows * update install docs * support external sources with shellcheck * shfmt * add external sources to GitHub action & unfold * change wording * first template docs * default to /usr/local instead * add option for binary name
2022-06-01 19:15:09 +00:00
```
docs: Add additional commands (#455) This adds a couple of missing pieces to the docs: - More info about `./develop.sh` - Steps to run the built coder binary manually - Starting the server - Logging in - Creating a project I attempted to keep them relatively agnostic so they wouldn't be out of date immediately when https://github.com/coder/coder/pull/422 is merged
2022-03-16 03:55:21 +00:00
chore: update link to go to Coder docs instead of GitHub (#2330)
2022-06-15 14:16:43 +00:00
Use `coder --help` to get a complete list of flags and environment variables. Use our [quickstart guide](https://coder.com/docs/coder-oss/latest/quickstart) for a full walkthrough.
chore(com): add docs for "coder projects update" (#732)
2022-04-01 18:48:45 +00:00
feat: initial docs pages (#1107) * docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * docs structure and edits to getting started * draft for about page * skeleton for concepts page * attempt at explaining templates * left-align tables * add best practices and variables * update structrure * update structure * templates are shared * workspaces docs * remove coming soon * fix typos * fix typos * Update docs/about.md Co-authored-by: Joe Previte <jjprevite@gmail.com> * remove line breaks between bullets * rename variables to parameters * reduce limits * chore: edit text * revert some changes, fix footnotes Co-authored-by: Katie Horne <katie@coder.com> Co-authored-by: Joe Previte <jjprevite@gmail.com>
2022-04-26 17:10:50 +00:00
## Documentation
chore: update link to go to Coder docs instead of GitHub (#2330)
2022-06-15 14:16:43 +00:00
Visit our docs [here](https://coder.com/docs/coder-oss).
added links to our issues to reduce necessary thinking to report issues
2022-05-30 19:19:48 +00:00
Move competitive comparison to README And rewrite a bit. Resolves #1365.
2022-05-27 16:34:03 +00:00
## Comparison
chore: remove index.md (#2403) * chore: fix broken link * chore: remove index.md
2022-06-16 14:46:01 +00:00
Please file [an issue](https://github.com/coder/coder/issues/new) if any information is out of date. Also refer to: [What Coder is not](https://coder.com/docs/coder-oss/latest/index#what-coder-is-not).
Move competitive comparison to README And rewrite a bit. Resolves #1365.
2022-05-27 16:34:03 +00:00
| Tool | Type | Delivery Model | Cost | Environments |
| :---------------------------------------------------------- | :------- | :----------------- | :---------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------- |
| [Coder](https://github.com/coder/coder) | Platform | OSS + Self-Managed | Pay your cloud | All [Terraform](https://www.terraform.io/registry/providers) resources, all clouds, multi-architecture: Linux, Mac, Windows, containers, VMs, amd64, arm64 |
| [code-server](https://github.com/cdr/code-server) | Web IDE | OSS + Self-Managed | Pay your cloud | Linux, Mac, Windows, containers, VMs, amd64, arm64 |
| [Coder (Classic)](https://coder.com/docs) | Platform | Self-Managed | Pay your cloud + license fees | Kubernetes Linux Containers |
| [GitHub Codespaces](https://github.com/features/codespaces) | Platform | SaaS | 2x Azure Compute | Linux containers |
---
docs: slim down readme (#2140) * docs: move docs table of contents to docs/index.md * docs: move how it works and IDE support to about.md * docs: move readme steps to walkthrough * docs: slim down readme * refactor: walkthrough -> quickstart * docs: minor edits
2022-06-08 15:37:03 +00:00
_Last updated: 5/27/22_
## Community and Support
Join our community on [Discord](https://discord.gg/coder) and [Twitter](https://twitter.com/coderhq)!
[Suggest improvements and report problems](https://github.com/coder/coder/issues/new/choose)
Move competitive comparison to README And rewrite a bit. Resolves #1365.
2022-05-27 16:34:03 +00:00
docs: move development workflow to CONTRIBUTING (#890)
2022-04-06 17:26:17 +00:00
## Contributing
chore: Add documentation of our phased approach to the UX (#15)
2022-01-11 21:05:49 +00:00
chore: update link to go to Coder docs instead of GitHub (#2330)
2022-06-15 14:16:43 +00:00
Read the [contributing docs](https://coder.com/docs/coder-oss/latest/CONTRIBUTING).
chore: Add Contributors section to readme (#1144) Co-authored-by: Cian Johnston <public@cianjohnston.ie>
2022-04-27 11:48:45 +00:00
docs(README): fix links to subpages (#1724)
2022-05-24 19:26:25 +00:00
Find our list of contributors [here](./docs/CONTRIBUTORS.md).