Add docs for packages (#24)

matifali · web-flow · commit ffefbe454548 · 2023-04-26T09:32:16.000+03:00
diff --git a/README.md b/README.md
@@ -2,12 +2,12 @@
 
 Install [Coder](https://github.com/coder/coder) to your preferred cloud with a pre-built package.
 
-| Logo                                                                                     | Platform Name         | Status      | Documentation                                                                                          | Deploy                                                                                                                                         |
-| ---------------------------------------------------------------------------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
-| <img src="./assets/ec2.svg" alt="AWS EC2 Logo" width="100" height="100" />               | AWS EC2               | Live ✅     | [Quickstart: AWS](https://coder.com/docs/v2/latest/quickstart/aws)                                     | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa)     |
-| <img src="./assets/fly.io.svg" alt="Fly.io Logo" width="100" height="100" />             | Fly.io                | Live ✅     | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io)            | [Deploy Coder on FLy.io](https://coder.com/blog/remote-developer-environments-on-fly-io)                                                       |
-| <img src="./assets/railway.svg" alt="Railway.app Logo" width="100" height="100" />       | Railway.app           | Live ✅     |                                                                                                        | [![Deploy on Railway](https://railway.app/button.svg)](https://railway.app/template/cUQ8_P?referralCode=tfH8Uw)                                |
-| <img src="./assets/heroku.svg" alt="Heroku Logo" width="100" height="100" />             | Heroku                | Live ✅     |                                                                                                  | [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages) |
-| <img src="./assets/render.png"  alt="Render.com Logo" width="100" height="100" />        | Render.com            | Live ✅     |                                                                                                        | [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/coder/packages) |
+| Logo                                                                                     | Platform Name         | Status      | Documentation                                                                                    | Deploy                                                                                                                                         |
+| ---------------------------------------------------------------------------------------- | --------------------- | ----------- | ------------------------------------------------------------------------------------------------ | ---------------------------------------------------------------------------------------------------------------------------------------------- |
+| <img src="./assets/ec2.svg" alt="AWS EC2 Logo" width="100" height="100" />               | AWS EC2               | Live ✅     | [Quickstart: AWS](https://coder.com/docs/v2/latest/quickstart/aws)                               | [Deploy from AWS Marketplace](https://aws.amazon.com/marketplace/pp/prodview-5gxjyur2vc7rg?sr=0-2&ref_=beagle&applicationId=AWSMPContessa)     |
+| <img src="./assets/fly.io.svg" alt="Fly.io Logo" width="100" height="100" />             | Fly.io                | Live ✅     | [Blog: Run Coder on Fly.io](https://coder.com/blog/remote-developer-environments-on-fly-io)      | [Deploy Coder on FLy.io](https://coder.com/blog/remote-developer-environments-on-fly-io)                                                       |
+| <img src="./assets/railway.svg" alt="Railway.app Logo" width="100" height="100" />       | Railway.app           | Live ✅     | [Blog: Run Coder on Railway.app](https://coder.com/blog/deploy-coder-on-railway-app)             | [![Deploy Coder on Railway](https://railway.app/button.svg)](https://railway.app/template/cUQ8_P?referralCode=tfH8Uw)                          |
+| <img src="./assets/heroku.svg" alt="Heroku Logo" width="100" height="100" />             | Heroku                | Live ✅     | [Docs: Deploy Coder on Heroku](./heroku/README.md)                                               | [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages) |
+| <img src="./assets/render.png"  alt="Render.com Logo" width="100" height="100" />        | Render                | Live ✅     | [Docs: Deploy Coder on Render](./render/README.md)                                               | [![Deploy to Render](https://render.com/images/deploy-to-render-button.svg)](https://render.com/deploy?repo=https://github.com/coder/packages) |
 | <img src="./assets/eks.svg" alt="AWS EKS Logo" width="100" height="100" />               | AWS EKS               | In progress | [Docs: Coder on Kubernetes](https://coder.com/docs/v2/latest/install/kubernetes)                 | [Deploy from AWS Marketplace](https://example.com)                                                                                             |
 | <img src="./assets/gce.svg" alt="Google Compute Engine logo" width="100" height="100" /> | Google Compute Engine | Considering | [Guide: Google Compute Engine](https://coder.com/docs/v2/latest/platforms/google-cloud-platform) |                                                                                                                                                |
diff --git a/heroku/README.md b/heroku/README.md
@@ -0,0 +1,50 @@
+# Coder on Heroku
+
+## Deploying a Coder instance to Heroku
+
+### Prerequisites
+
+- A Heroku account
+- Heroku CLI installed
+
+### Steps
+
+1. Create a new Heroku app by using our deploy button below. This will automatically create a new app and deploy the latest version of Coder to it along with a basic postgres database.
+
+   [![Deploy Coder on Heroku](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/coder/packages)
+
+2. Enable dyno metadata by running the following command in the terminal:
+
+   ```bash
+   heroku labs:enable runtime-dyno-metadata -a <app-name>
+   ```
+
+   Replace `<app-name>` with the name of your Heroku app.
+
+   > **Note:** `HEROKU_APP_NAME` is required by Coder to configure the `CODER_ACCESS_URL` environment variable. This is made available by enabling dyno metadata.
+
+3. Clone the repository to your local machine and connect it to your Heroku app by running the following commands in the terminal:
+
+   ```bash
+   git clone https://githib.com/coder/packages
+   heroku git:remote -a <app-name>
+   ```
+
+   Replace `<app-name>` with the name of your Heroku app.
+
+## Updating Coder
+
+If you want to update Coder to the latest version, you can redeploy your app by running the following command from the root of your repository:
+
+```bash
+git pull origin main
+git push heroku main
+```
+
+Replace `<app-name>` with the name of your Heroku app.
+
+## Next steps
+
+- Check out our [documentation](https://coder.com/docs) to learn how to configure your Coder instance.
+
+- You can add environment variables to an Heroku app by going to the app's settings page and clicking on the "Reveal Config Vars" button.
