Skip to content

Commit

Permalink
Vin/nixpacks docs update (#621)
Browse files Browse the repository at this point in the history
* Alphebatize and add missing providers from Nixpacks docs

* Added Microsoft Container registry to supported images list

* Updated grammar and headings for consistency across articles
  • Loading branch information
vinisadev authored Dec 4, 2024
1 parent 6fb81ac commit a1a0bdf
Show file tree
Hide file tree
Showing 44 changed files with 178 additions and 167 deletions.
12 changes: 6 additions & 6 deletions src/docs/guides/astro.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ For the remaining options, select the defaults and press Enter. All necessary de

A new Astro app will be provisioned for you in the `blog` directory.

### Run the Astro App locally
### Run the Astro App Locally

Enter your project directory using `cd blog`.

Expand All @@ -45,7 +45,7 @@ npm run dev

Open your browser and go to `http://localhost:4321` to see your app.

### Enable Server side rendering (SSR)
### Enable Server Side Rendering (SSR)

Astro has several [SSR adapters](https://docs.astro.build/en/guides/server-side-rendering/). These adapters are used to run your project on the server and handle SSR requests.

Expand Down Expand Up @@ -86,7 +86,7 @@ In the config file, `output` is set to `server`, meaning every page in the app i

For mostly static sites, set `output` to `hybrid`. This allows you to add `export const prerender = false` to any file that needs to be server-rendered on demand.

### Modify Start Script and Astro config
### Modify Start Script and Astro Config

Astro builds your project into a `dist` directory. In `standalone` mode, a server starts when the server entry point is executed, which is by default located at `./dist/server/entry.mjs`.

Expand Down Expand Up @@ -133,7 +133,7 @@ Your app needs to listen on either `0.0.0.0` or `::` to accept traffic. If not c

Railway offers multiple ways to deploy your Astro app, depending on your setup and preference.

### One-Click Deploy from a Template
### One-Click Deploy From a Template

If you’re looking for the fastest way to get started, the one-click deploy option is ideal.

Expand All @@ -145,7 +145,7 @@ We highly recommend that [you eject from the template after deployment](/guides/

**Note:** You can also choose from a <a href="https://railway.com/templates?q=astro" target="_blank">variety of Astro app templates</a> created by the community.

### Deploy from the CLI
### Deploy From the CLI

1. **Install the Railway CLI**:
- <a href="/guides/cli#installing-the-cli" target="_blank">Install the CLI</a> and <a href="/guides/cli#authenticating-with-the-cli" target="_blank">authenticate it</a> using your Railway account.
Expand All @@ -172,7 +172,7 @@ alt="screenshot of the deployed Astro service"
layout="responsive"
width={2556} height={2164} quality={100} />
### Deploy from a GitHub Repo
### Deploy From a GitHub Repo
To deploy an Astro app to Railway directly from GitHub, follow the steps below:
Expand Down
10 changes: 5 additions & 5 deletions src/docs/guides/axum.md
Original file line number Diff line number Diff line change
Expand Up @@ -83,7 +83,7 @@ The Router from Axum is used to configure the route, and `tokio::net::TcpListene

The asynchronous runtime, provided by the `#[tokio::main]` macro, ensures the server can handle requests efficiently. The `axum::serve` function integrates with the Hyper server to actually process requests.

### Run the Axum App locally
### Run the Axum App Locally

Run the following command in the `helloworld` directory via the terminal:

Expand All @@ -99,7 +99,7 @@ Open your browser and go to `http://localhost:3000` to see your app.

Railway offers multiple ways to deploy your Axum app, depending on your setup and preference.

### One-Click Deploy from a Template
### One-Click Deploy From a Template

If you’re looking for the fastest way to get started, the one-click deploy option is ideal.

Expand All @@ -111,7 +111,7 @@ We highly recommend that [you eject from the template after deployment](/guides/

**Note:** You can also choose from a <a href="https://railway.com/templates?q=axum" target="_blank">variety of Axum templates</a> created by the community.

### Deploy from the CLI
### Deploy From the CLI

1. **Install the Railway CLI**:
- <a href="/guides/cli#installing-the-cli" target="_blank">Install the CLI</a> and <a href="/guides/cli#authenticating-with-the-cli" target="_blank">authenticate it</a> using your Railway account.
Expand Down Expand Up @@ -141,7 +141,7 @@ alt="screenshot of the deployed Axum service"
layout="responsive"
width={1982} height={1822} quality={100} />
### Deploy from a GitHub Repo
### Deploy From a GitHub Repo
To deploy an Axum app to Railway directly from GitHub, follow the steps below:
Expand Down Expand Up @@ -200,4 +200,4 @@ This guide covers the main deployment options on Railway. Choose the approach th
Explore these resources to learn how you can maximize your experience with Railway:

- [Add a Database Service](/guides/build-a-database-service)
- [Monitor your app](/guides/monitoring)
- [Monitor your app](/guides/monitoring)
12 changes: 6 additions & 6 deletions src/docs/guides/beego.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,7 +103,7 @@ Replace this `postgres://username:@localhost/helloworld_dev?sslmode=disable` wit
- The `init()` function registers the Postgres driver, registers the Users model, and automatically creates the users table in the database. If any errors occur while inserting users, they are logged.
- The `main()` function creates an ORM instance, defines sample user data (first name and last name), inserts the data into the users table, and starts the Beego web server to serve your app.

### Run the Beego App locally
### Run the Beego App Locally

To start your app, run:

Expand All @@ -115,7 +115,7 @@ Once the app is running, open your browser and navigate to `http://localhost:808

In your terminal, you’ll see logs indicating that the user data is being inserted. Head over to your database, and you should see the users table populated with the seeded data.

### Prepare Beego App for deployment
### Prepare Beego App for Deployment

1. Open the `conf/app.conf` file and add an environment variable, `DATABASE_URL` to it.

Expand Down Expand Up @@ -150,7 +150,7 @@ func init() {

Railway offers multiple ways to deploy your Beego app, depending on your setup and preference.

### One-Click Deploy from a Template
### One-Click Deploy From a Template

If you’re looking for the fastest way to get started, the one-click deploy option is ideal.

Expand All @@ -162,7 +162,7 @@ We highly recommend that [you eject from the template after deployment](/guides/

**Note:** You can also choose from a <a href="https://railway.com/templates?q=beego" target="_blank">variety of Beego app templates</a> created by the community.

### Deploy from the CLI
### Deploy From the CLI

1. **Install the Railway CLI**:
- <a href="/guides/cli#installing-the-cli" target="_blank">Install the CLI</a> and <a href="/guides/cli#authenticating-with-the-cli" target="_blank">authenticate it</a> using your Railway account.
Expand Down Expand Up @@ -198,7 +198,7 @@ alt="screenshot of the deployed Beego service"
layout="responsive"
width={2420} height={1986} quality={100} />
### Deploy from a GitHub Repo
### Deploy From a GitHub Repo
To deploy a Beego app to Railway directly from GitHub, follow the steps below:
Expand Down Expand Up @@ -260,4 +260,4 @@ This guide covers the main deployment options on Railway. Choose the approach th
Explore these resources to learn how you can maximize your experience with Railway:

- [Add a Database Service](/guides/build-a-database-service)
- [Monitor your app](/guides/monitoring)
- [Monitor your app](/guides/monitoring)
10 changes: 5 additions & 5 deletions src/docs/guides/build-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,7 +82,7 @@ Here are a few examples of common use-cases:

_Note, negations will only work if you include files in a preceding rule._

## Install a specific package using Nixpacks
## Install a Specific Package Using Nixpacks

When using Nixpacks, you can install specific packages by defining them in a nixpacks configuration file. For example:

Expand Down Expand Up @@ -118,20 +118,20 @@ HTTP traffic.
_Note: Some buildpacks specify a default start command_


## Specify a custom install command
## Specify a Custom Install Command

We do not expose a way to configure a custom install command in the UI, but you can control this using [config as code](/reference/config-as-code#nixpacks-plan) (see Nixpacks Plan -> Install Command).

## Disable build layer caching
## Disable Build Layer Caching

By default, Railway will cache build layers to provide faster build times. If you have a need to disable this behavior, set the following environment variable in your service:

```plaintext
NO_CACHE=1
```

## Why isn't my build using cache?
## Why Isn't My Build Using Cache?

Since Railway's build system scales up and down in response to demand, cache hit on builds is not guaranteed.

If you have a need for faster builds and rely on build cache to satisfy that requirement, you should consider creating a pipeline to build your own image and deploy your image directly.
If you have a need for faster builds and rely on build cache to satisfy that requirement, you should consider creating a pipeline to build your own image and deploy your image directly.
2 changes: 1 addition & 1 deletion src/docs/guides/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ The Railway CLI is an open source project on [GitHub](https://github.com/railway
You can build a binary [from source](https://github.com/railwayapp/cli#from-source)
if you wish.

## Authenticating with the CLI
## Authenticating With the CLI

Before you can use the Railway CLI, you must authenticate the CLI to your Railway account:
```bash
Expand Down
4 changes: 2 additions & 2 deletions src/docs/guides/create.md
Original file line number Diff line number Diff line change
Expand Up @@ -50,7 +50,7 @@ quality={80}

If you do not see the `Edit Scope` option, you may still need to connect GitHub to your Railway account.

### Convert a Project into a Template
### Convert a Project Into a Template

You can also convert an existing project into a ready-made Template for other users.

Expand Down Expand Up @@ -122,7 +122,7 @@ The current template variable functions are:

2. `randomInt(min?: number, max?: number)`: Generates a random integer between min and max (defaults to 0 and 100)

## Managing your Templates
## Managing Your Templates

You can see all of your templates on your <a href="https://railway.com/account/templates" target="_blank">Account's Template page</a>. Templates are separated into Personal and Published templates.

Expand Down
4 changes: 2 additions & 2 deletions src/docs/guides/cron-jobs.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,10 @@ To configure a cron job -

Find more information about cron jobs, including examples of cron expressions, in the [reference page for Cron Jobs](/reference/cron-jobs).

## Why isn't my Cron running as scheduled?
## Why Isn't My Cron Running as Scheduled?

An important requirement of a service that runs as a Cron, is that it terminates on completion and leaves no open resources. If the code that runs in your Cron service does not exit, subsequent executions of the Cron will be skipped.

If you see that a previous execution of your Cron service has a status of `Active`, the execution is still running and any new executions will not be run.

For more information on Service execution requirements, see the [Service Execution Requirements](/reference/cron-jobs#service-execution-requirements) section of the Cron Jobs reference.
For more information on Service execution requirements, see the [Service Execution Requirements](/reference/cron-jobs#service-execution-requirements) section of the Cron Jobs reference.
8 changes: 4 additions & 4 deletions src/docs/guides/django.md
Original file line number Diff line number Diff line change
Expand Up @@ -169,7 +169,7 @@ Railway offers multiple ways to deploy your Django app, depending on your setup
2. [Using the CLI](#deploy-from-the-cli).
3. [From a GitHub repository](#deploy-from-a-github-repo).

## One-Click Deploy from a Template
## One-Click Deploy From a Template

If you’re looking for the fastest way to get started, the one-click deploy option is ideal. It sets up a Django app along with a Postgres database.

Expand All @@ -179,7 +179,7 @@ Click the button below to begin:

After deploying, we recommend that you [eject from the template](/guides/deploy#eject-from-template-repository) to create a copy of the repository under your own GitHub account. This will give you full control over the source code and project.

## Deploy from the CLI
## Deploy From the CLI

To deploy the Django app using the Railway CLI, please follow the steps:

Expand Down Expand Up @@ -226,7 +226,7 @@ layout="responsive"
width={2783} height={2135} quality={100} />


## Deploy from a GitHub Repo
## Deploy From a GitHub Repo

To deploy the Django app to Railway, start by pushing the app to a GitHub repo. Once that’s set up, follow the steps below to complete the deployment process.

Expand Down Expand Up @@ -350,4 +350,4 @@ width={2752} height={2094} quality={100} />
Explore these resources to learn how you can maximize your experience with Railway:
- [Monitoring](/guides/monitoring)
- [Deployments](/guides/deployments)
- [Deployments](/guides/deployments)
2 changes: 1 addition & 1 deletion src/docs/guides/environments.md
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ width={480} height={156} quality={80} />

When enabled, a temporary environment is spun up to support the Pull Request deploy. These environments are deleted as soon as these PRs are merged or closed.

### How come my GitHub PR won't deploy?
### How Come my GitHub PR Won't Deploy?

Railway will not deploy a PR branch from a user who is not in your team or invited to your project without their associated GitHub account.

Expand Down
8 changes: 4 additions & 4 deletions src/docs/guides/express.md
Original file line number Diff line number Diff line change
Expand Up @@ -102,7 +102,7 @@ block content

5. Run the app again to see your changes in action!

### Prepare Express App for deployment
### Prepare Express App for Deployment

In the `routes/index.js` file, replace the hardcoded Postgres database URL with an environment variable:

Expand All @@ -118,7 +118,7 @@ This allows the app to dynamically pull the correct database configuration from

Railway offers multiple ways to deploy your Express app, depending on your setup and preference.

### One-Click Deploy from a Template
### One-Click Deploy From a Template

If you’re looking for the fastest way to get started with Express, Pug and connected to a Postgres database, the one-click deploy option is ideal.

Expand All @@ -134,7 +134,7 @@ We highly recommend that [you eject from the template after deployment](/guides/

**Note:** You can also choose from a <a href="https://railway.app/templates?q=express" target="_blank">variety of Express app templates</a> created by the community.

### Deploy from the CLI
### Deploy From the CLI

1. **Install the Railway CLI**:
- <a href="/guides/cli#installing-the-cli" target="_blank">Install the CLI</a> and <a href="/guides/cli#authenticating-with-the-cli" target="_blank">authenticate it</a> using your Railway account.
Expand Down Expand Up @@ -170,7 +170,7 @@ alt="screenshot of the deployed Express service"
layout="responsive"
width={2194} height={1652} quality={100} />
### Deploy from a GitHub Repo
### Deploy From a GitHub Repo
To deploy an Express app to Railway directly from GitHub, follow the steps below:
Expand Down
6 changes: 3 additions & 3 deletions src/docs/guides/fastapi.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ This guide covers how to deploy a FastAPI app on Railway in four ways:
3. [Using the CLI](#deploy-from-the-cli).
4. [Using a Dockerfile](#use-a-dockerfile).

## One-Click Deploy from a Template
## One-Click Deploy From a Template

[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/template/-NvLj4)

We highly recommend that [you eject from the template after deployment](/guides/deploy#eject-from-template-repository) to create a copy of the repo on your GitHub account.

**Note:** You can also choose from a <a href="https://railway.com/templates?q=fastapi" target="_blank">variety of FastAPI app templates</a> created by the community.

## Deploy from a GitHub Repo
## Deploy From a GitHub Repo

To deploy a FastAPI app on Railway directly from GitHub, follow the steps below:

Expand All @@ -44,7 +44,7 @@ The FastAPI app is run via a <a href="https://hypercorn.readthedocs.io/en/latest

Railway makes it easy to define deployment configurations for your services directly in your project using a <a href="/guides/config-as-code" target="_blank">railway.toml or railway.json file</a>, alongside your code.

## Deploy from the CLI
## Deploy From the CLI

1. <a href="/guides/cli#installing-the-cli" target="_blank">Install</a> and <a href="/guides/cli#authenticating-with-the-cli" target="_blank">authenticate with the CLI.</a>
2. Clone the forked <a href="https://github.com/railwayapp-templates/fastify" target="_blank">fastapi GitHub repo</a> and `cd` into the directory.
Expand Down
6 changes: 3 additions & 3 deletions src/docs/guides/fastify.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,15 +11,15 @@ This guide covers how to deploy a Fastify app on Railway in four ways:
3. [Using the CLI](#deploy-from-the-cli).
4. [Using a Dockerfile](#use-a-dockerfile).

## One-Click Deploy from a Template
## One-Click Deploy From a Template

[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/new/template/ZZ50Bj)

We highly recommend that [you eject from the template after deployment](/guides/deploy#eject-from-template-repository) to create a copy of the repo on your GitHub account.

**Note:** You can also choose from a <a href="https://railway.com/templates?q=fastify" target="_blank">variety of Fastify app templates</a> created by the community.

## Deploy from a GitHub Repo
## Deploy From a GitHub Repo

To deploy a Fastify app on Railway directly from GitHub, follow the steps below:

Expand All @@ -46,7 +46,7 @@ You can find this in the <a href="https://github.com/railwayapp-templates/fastif
If you don’t set it correctly, you may encounter a 502 error page.


## Deploy from the CLI
## Deploy From the CLI

1. <a href="/guides/cli#installing-the-cli" target="_blank">Install</a> and <a href="/guides/cli#authenticating-with-the-cli" target="_blank">authenticate with the CLI.</a>
2. Clone the forked <a href="https://github.com/railwayapp-templates/fastify" target="_blank">fastify GitHub repo</a> and `cd` into the directory.
Expand Down
2 changes: 1 addition & 1 deletion src/docs/guides/fixing-common-errors.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ When deploying to Railway, you may encounter some errors that prevent your
application from working as expected. These are descriptions and solutions to errors that
users commonly encounter.

## Application failed to respond
## Application Failed to Respond

After deploying your application or making changes, you might encounter this screen when accessing your application's domain:

Expand Down
Loading

0 comments on commit a1a0bdf

Please sign in to comment.