Skip to content

Commit

Permalink
Melissa/triage tickets (#593)
Browse files Browse the repository at this point in the history
* info about installing packages with nixpacks

Signed-off-by: Melissa Hale <[email protected]>

* wait for ci

Signed-off-by: Melissa Hale <[email protected]>

* build cache info

Signed-off-by: Melissa Hale <[email protected]>

* grow volume

Signed-off-by: Melissa Hale <[email protected]>

* preferred region

Signed-off-by: Melissa Hale <[email protected]>

---------

Signed-off-by: Melissa Hale <[email protected]>
  • Loading branch information
melissa-hale authored Oct 30, 2024
1 parent be72726 commit 1e377bd
Show file tree
Hide file tree
Showing 5 changed files with 62 additions and 10 deletions.
19 changes: 18 additions & 1 deletion src/docs/guides/build-configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,6 +82,17 @@ 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

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

```toml
[phases.setup]
aptPkgs = ['wget']
```

See the [Nixpacks docs](https://nixpacks.com/docs/configuration/file) for more information.

## Build Providers

With Nixpacks, we analyze the app source directory and generate a build plan. This determines for which language provider to install packages and runtimes.
Expand Down Expand Up @@ -117,4 +128,10 @@ By default, Railway will cache build layers to provide faster build times. If y

```plaintext
NO_CACHE=1
```
```

## 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.
10 changes: 5 additions & 5 deletions src/docs/guides/github-autodeploys.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,15 +22,15 @@ To disable automatic deployment, simply hit `Disconnect` in the Service Settings

*Currently, there is no way to force a deploy from a branch other than the Default without connecting it in your service settings.*

## Check Suites
## Wait for CI

<Banner variant="info">
Please make sure you have{" "}
<a href="https://github.com/settings/installations" target="_blank">accepted our updated GitHub permissions</a>
required for this feature to work.
</Banner>

To ensure Railway waits for your GitHub Actions to run successfully before triggering a new deployment, you should enable Check Suites.
To ensure Railway waits for your GitHub Actions to run successfully before triggering a new deployment, you should enable **Wait for CI**.

#### Requirements

Expand All @@ -44,11 +44,11 @@ To ensure Railway waits for your GitHub Actions to run successfully before trigg
- main
```

### Enabling Check Suites
### Enabling Wait for CI

If your workflow satisfies the requirements above, you will see the `Check Suites` flag in service settings.
If your workflow satisfies the requirements above, you will see the `Wait for CI` flag in service settings.

<Image src="https://res.cloudinary.com/railway/image/upload/v1671003153/docs/check-suites.png" alt="Check Suites Configuration" layout="responsive" width={1340} height={392} quality={80} />
<Image src="https://res.cloudinary.com/railway/image/upload/v1730324753/docs/deployments/waitforci_dkfsxy.png" alt="Check Suites Configuration" layout="responsive" width={1340} height={392} quality={80} />

Toggle this on to ensure Railway waits for your GitHub Actions to run successfully before triggering a new deployment.

Expand Down
15 changes: 15 additions & 0 deletions src/docs/guides/optimize-performance.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,21 @@ To choose a different region for your service, go to your service settings and s

*Additional regions may be added in the future as Railway continues expanding its infrastructure footprint.*

### Set a default region

To set a default, or preferred, region, do so from the command palette. From your project settings:
- Type `CMD+K` or `Ctrl+K` to access the command palette
- Type "preferred region"
- Select your preferred region

<Image
quality={100}
width={959}
height={651}
src="https://res.cloudinary.com/railway/image/upload/v1730327915/docs/preferredRegion_i33w6q.png"
alt="Preferred Region Picker"
/>

### Impact of Region Changes

For information on the impact of changing a service's region, see the [Regions reference guide](/reference/deployment-regions#impact-of-region-changes).
Expand Down
20 changes: 20 additions & 0 deletions src/docs/guides/volumes.md
Original file line number Diff line number Diff line change
Expand Up @@ -95,3 +95,23 @@ Volumes are mounted as the `root` user. If you run an image that uses a non-roo
```
RAILWAY_RUN_UID=0
```

## Growing the Volume

***Only available to Pro users and above.***

To increase capacity in a volume, you can "grow" it from the volume settings.
- Click on the volume to open the settings
- Click `Grow`
- Follow the prompts to grow the volume

<Image
layout="intrinsic"
quality={100}
width={1148}
height={584}
src="https://res.cloudinary.com/railway/image/upload/v1730326473/docs/volumes/growvolume_zbsjjq.png"
alt="Grow volume"
/>

Note: growing a volume requires a restart of the attached service.
8 changes: 4 additions & 4 deletions src/docs/reference/pricing/plans.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,12 +34,12 @@ Depending on the plan you are on, you are allowed to use up these resources per
| -------------- | ---------- | ----------- | --------------------- | ------------------ |
| **Trial** | **0.5 GB** | **2 vCPU** | **1 GB** | **0.5 GB** |
| **Hobby** | **8 GB** | **8 vCPU** | **10 GB** | **5 GB** |
| **Pro** | **32 GB** | **32 vCPU** | **100 GB** | **50 GB** |
| **Enterprise** | **64 GB** | **64 vCPU** | **100 GB** | **50 GB** |
| **Pro** | **32 GB** | **32 vCPU** | **100 GB** | **50 GB**** |
| **Enterprise** | **64 GB** | **64 vCPU** | **100 GB** | **50 GB**** |

Please note that these are initial values and users on the Pro and Enterprise plans can request limit increases.
Note that these are initial values and users on the Pro and Enterprise plans can request limit increases.

Pro users and above can self-serve to increase their volume up to 250 GB.
**For Volumes, Pro users and above can self-serve to increase their volume up to 250 GB. Check out [this guide](/guides/volumes#growing-the-volume) for information.

### Resource Usage Pricing

Expand Down

0 comments on commit 1e377bd

Please sign in to comment.