Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions docs/cloud/cache/authenticating/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ description:
in."
---

## Managing Access to the Cache[](#managing-access-to-the-cache "Direct link to Managing Access to the Cache")
## Managing Access to the Cache[](#managing-access-to-the-cache "Direct link to Managing Access to the Cache")

Team members can be added in one of two Roles, which controls their access to the Jetify Build
Cache.
Expand All @@ -17,7 +17,7 @@ Cache.
You can add or remove team members from your team, or modify their role, using the
[Jetify Cloud Dashboard](/docs/cloud/dashboard/inviting-members/)

## Authenticating from the CLI[](#authenticating-from-the-cli "Direct link to Authenticating from the CLI")
## Authenticating from the CLI[](#authenticating-from-the-cli "Direct link to Authenticating from the CLI")

Once you’ve been invited to a team, you can authenticate from the CLI by running:

Expand Down Expand Up @@ -46,7 +46,7 @@ You can logout by running:
devbox auth logout
```

### Authenticating CI or Build Hosts[](#authenticating-ci-or-build-hosts "Direct link to Authenticating CI or Build Hosts")
### Authenticating CI or Build Hosts[](#authenticating-ci-or-build-hosts "Direct link to Authenticating CI or Build Hosts")

Admin users can generate Personal Access Tokens to authenticate on hosts where you cannot login via
the CLI or Browser. This token will have the same push/pull permissions as the account that
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/cache/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ Jetify Cache provides the following features:
and makes it easy to revoke access directly from the dashboard. Jetify also supports Single Sign
On for Enterprise Cache users

## Guides[](#guides "Direct link to Guides")
## Guides[](#guides "Direct link to Guides")

- [Setting Up Jetify Cache](/docs/cloud/cache/authenticating/)
- [Pushing and Pulling Packages from the Cache](/docs/cloud/cache/usage/)
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/cache/prebuilt-cache/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ which are not available by default. This includes:
2. Packages which have not been built for certain platforms
3. Packages with unfree licenses, which are not automatically built by NixOS

## Using the Prebuilt Cache[](#using-the-prebuilt-cache "Direct link to Using the Prebuilt Cache")
## Using the Prebuilt Cache[](#using-the-prebuilt-cache "Direct link to Using the Prebuilt Cache")

The Prebuilt Cache is available for free to every developer who signs up for a Jetify Cloud account.
Devbox will automatically configure itself to use the Prebuilt Cache when you login with
Expand All @@ -25,7 +25,7 @@ Solo, Starter, and Scaleup accounts have unlimited access to the Prebuilt Cache.

</Info>

## Packages included in the Prebuilt Cache[](#packages-included-in-the-prebuilt-cache "Direct link to Packages included in the Prebuilt Cache")
## Packages included in the Prebuilt Cache[](#packages-included-in-the-prebuilt-cache "Direct link to Packages included in the Prebuilt Cache")

Some of the packages included in the Prebuilt Cache are:

Expand Down
8 changes: 4 additions & 4 deletions docs/cloud/cache/usage/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Pushing and Pulling Packages to the Cache"
---

## Pulling Packages from the Cache[](#pulling-packages-from-the-cache "Direct link to Pulling Packages from the Cache")
## Pulling Packages from the Cache[](#pulling-packages-from-the-cache "Direct link to Pulling Packages from the Cache")

Once you have authenticated, Devbox will automatically configure your cache for you. You can also
manually configure the cache by running:
Expand All @@ -21,12 +21,12 @@ binary in the following locations:

If the package is not available in those locations, then it will build the package from source.

## Pushing to the Cache[](#pushing-to-the-cache "Direct link to Pushing to the Cache")
## Pushing to the Cache[](#pushing-to-the-cache "Direct link to Pushing to the Cache")

You can push custom packages and project closures to your Jetify Cache directly from the Devbox CLI.
Push access is currently only available for authenticated users with Admin permissions.

### **Pushing a Devbox Project**[](#pushing-a-devbox-project "Direct link to pushing-a-devbox-project")
### **Pushing a Devbox Project**[](#pushing-a-devbox-project "Direct link to pushing-a-devbox-project")

You can push the entire closure of a Devbox project to the Jetify Cache by navigating to your
project root and running
Expand All @@ -35,7 +35,7 @@ project root and running
devbox cache upload
```

### Pushing a specific package[](#pushing-a-specific-package "Direct link to Pushing a specific package")
### Pushing a specific package[](#pushing-a-specific-package "Direct link to Pushing a specific package")

You can also push a single package by passing a flake reference to the Devbox CLI.

Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/dashboard/creating-your-team/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ collaborate on projects in Jetify Cloud.

Users with a free account can upgrade to a paid team on the dashboard anytime.

## Creating a New Team Account[](#creating-a-new-team-account "Direct link to Creating a New Team Account")
## Creating a New Team Account[](#creating-a-new-team-account "Direct link to Creating a New Team Account")

1. From the Team Selector in the top right of your dashboard, select **Create a New Team**

Expand All @@ -29,7 +29,7 @@ Users with a free account can upgrade to a paid team on the dashboard anytime.
1. Your new team will be created, and you will be automatically switched to your new team. You can
now [invite other members](/docs/cloud/dashboard/inviting-members/) to join your team.

## Billing[](#billing "Direct link to Billing")
## Billing[](#billing "Direct link to Billing")

Free accounts are free forever. You will need to add a payment method to unlock paid tier features.

Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/dashboard/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description:

You can visit the Jetify Dashboard at [cloud.jetify.com](https://cloud.jetify.com)

## Guides[](#guides "Direct link to Guides")
## Guides[](#guides "Direct link to Guides")

- [Creating Your Team](/docs/cloud/dashboard/creating-your-team/)
- [Inviting Members](/docs/cloud/dashboard/inviting-members/)
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/dashboard/inviting-members/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ Team members can be added in one of two Roles:
- **Admins:** Have all the permissions of Members, but can also invite new team members and
configure project billing

## Adding a Team Member[](#adding-a-team-member "Direct link to Adding a Team Member")
## Adding a Team Member[](#adding-a-team-member "Direct link to Adding a Team Member")

1. In the Jetify Dashboard, navigate to the **Members** tab

Expand All @@ -40,7 +40,7 @@ Team members can be added in one of two Roles:

![Active Member](./member-status-active.png)

## Removing a Team Member[](#removing-a-team-member "Direct link to Removing a Team Member")
## Removing a Team Member[](#removing-a-team-member "Direct link to Removing a Team Member")

Removing a team member will remove their access to all projects and secrets in your team. To remove
a team member
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/deploys/custom-domains/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ description:
You will need access to the DNS records for your Domain in order to configure it for Jetify Cloud.
</Info>

## Adding a Custom Domain[](#adding-a-custom-domain "Direct link to Adding a Custom Domain")
## Adding a Custom Domain[](#adding-a-custom-domain "Direct link to Adding a Custom Domain")

1. In your project on the Jetify Cloud Dashboard, select **Settings**
2. Scroll down to the **Custom Domain** section on the settings page
Expand All @@ -24,7 +24,7 @@ description:
**Issued** status:
![Custom Domain Issued](./custom-domain-status-issued.png)

## Removing a Custom Domain[](#removing-a-custom-domain "Direct link to Removing a Custom Domain")
## Removing a Custom Domain[](#removing-a-custom-domain "Direct link to Removing a Custom Domain")

You can remove a custom domain by clicking the Delete button. This will remove the domain from your
project. Note that after removing the domain, you may want to also clean up your DNS records.
12 changes: 6 additions & 6 deletions docs/cloud/deploys/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -13,13 +13,13 @@ description:
Pricing](https://www.jetify.com/cloud/pricing).
</Info>

## Quickstart[](#quickstart "Direct link to Quickstart")
## Quickstart[](#quickstart "Direct link to Quickstart")

This quickstart will walk through how to configure and deploy a project with Jetify Cloud. We'll
start by forking an example repo that is configured for Jetify Deployments, and then demonstrate how
to connect your Github repo and activate deploys for your account.

## Forking the Example Repo[](#forking-the-example-repo "Direct link to Forking the Example Repo")
## Forking the Example Repo[](#forking-the-example-repo "Direct link to Forking the Example Repo")

To help you get started with Jetify Cloud, we've created an
[example Rails app](https://github.com/jetify-com/jetify-deploy-example) that's been configured to
Expand All @@ -28,7 +28,7 @@ deploy with Jetify Cloud.
You can fork this repo from the Github UI to add it to your account, or clone and push the repo to
your Github account.

## Connecting your Repo to Jetify Cloud[](#connecting-your-repo-to-jetify-cloud "Direct link to Connecting your Repo to Jetify Cloud")
## Connecting your Repo to Jetify Cloud[](#connecting-your-repo-to-jetify-cloud "Direct link to Connecting your Repo to Jetify Cloud")

First, you'll need to sign-in with Github and connect your project to Jetify Cloud:

Expand All @@ -42,7 +42,7 @@ First, you'll need to sign-in with Github and connect your project to Jetify Clo

Once your project is added to Jetify Cloud, you can configure your secrets or deployments.

## Deploying your Site[](#deploying-your-site "Direct link to Deploying your Site")
## Deploying your Site[](#deploying-your-site "Direct link to Deploying your Site")

1. Select the Deploys tab in your project
2. Click the **Enable Deployments** button to turn on Jetify Deployments for your project
Expand All @@ -52,14 +52,14 @@ Once your project is added to Jetify Cloud, you can configure your secrets or de
If your site fails to deploy, or if you want to update your deployment, push a commit to the default
branch of your repo to trigger a new deploy.

## Visiting your Site[](#visiting-your-site "Direct link to Visiting your Site")
## Visiting your Site[](#visiting-your-site "Direct link to Visiting your Site")

When your site has finished deploying, Jetify Cloud will display a preview URL that you can visit to
test your application.

Congratulations! You've now deployed your first site with Jetify Cloud.

## Next Steps[](#next-steps "Direct link to Next Steps")
## Next Steps[](#next-steps "Direct link to Next Steps")

- Learn more about [setting up your project](/docs/cloud/deploys/setup/)
- Set up a [custom domain](/docs/cloud/deploys/custom-domains/) for your application
Expand Down
4 changes: 2 additions & 2 deletions docs/cloud/deploys/integrations/s3/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ description:
You can view an example of this integration on
[Github](https://github.com/jetify-com/jetify-deploy-integration/tree/main/devbox-json/s3)

## Setting up S3[](#setting-up-s3 "Direct link to Setting up S3")
## Setting up S3[](#setting-up-s3 "Direct link to Setting up S3")

If you don't already have an S3 bucket configured, you will need an
[AWS account](https://docs.aws.amazon.com/SetUp/latest/UserGuide/setup-overview.html) + IAM user
Expand All @@ -28,7 +28,7 @@ and an [IAM User Policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/w
allow your user to securely access the bucket. Consult the S3 documentation for more details on how
to configure the correct policy for your needs.

## Connecting Jetify Cloud to your S3 Account[](#connecting-jetify-cloud-to-your-s3-account "Direct link to Connecting Jetify Cloud to your S3 Account")
## Connecting Jetify Cloud to your S3 Account[](#connecting-jetify-cloud-to-your-s3-account "Direct link to Connecting Jetify Cloud to your S3 Account")

If you want your Jetify Cloud App to push and pull objects from your S3 Bucket, you can use Jetify
Secrets to set your AWS Access Key ID and Secret in your environment:
Expand Down
6 changes: 3 additions & 3 deletions docs/cloud/deploys/integrations/supabase/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ description:
You can view an example of this integration on
[Github](https://github.com/jetify-com/jetify-deploy-integration/tree/main/devbox-json/supabase)

## Setting up Supabase[](#setting-up-supabase "Direct link to Setting up Supabase")
## Setting up Supabase[](#setting-up-supabase "Direct link to Setting up Supabase")

If you don't have one already, you will first need to create an organization and project in Supabase
to use with Jetify Cloud. If you are just testing Supabase with Jetify, you can create a free
Expand All @@ -19,7 +19,7 @@ personal organization to start. For more details, see the [Supabase Docs](https:
If you plan to connect using PostgreSQL connection parameters, make sure that you save your Database
password at creation time since you may need it to connect.

## Connecting using the Supabase API or Clients[](#connecting-using-the-supabase-api-or-clients "Direct link to Connecting using the Supabase API or Clients")
## Connecting using the Supabase API or Clients[](#connecting-using-the-supabase-api-or-clients "Direct link to Connecting using the Supabase API or Clients")

The simplest way to connect to Supabase is via the API or one of Supabase's client libraries.
Connecting via the API also lets you use Supabase's advanced realtime and streaming features.
Expand Down Expand Up @@ -57,7 +57,7 @@ key: str = os.getenv('SUPABASE_KEY')
supabase: Client = create_client(url, key)
```

## Connecting via PostgreSQL Connection Parameters[](#connecting-via-postgresql-connection-parameters "Direct link to Connecting via PostgreSQL Connection Parameters")
## Connecting via PostgreSQL Connection Parameters[](#connecting-via-postgresql-connection-parameters "Direct link to Connecting via PostgreSQL Connection Parameters")

You can also connect to your database using the standard PostgreSQL Database connection parameters.
This is useful if your project cannot use the Supabase API, or if it requires a standard PostgreSQL
Expand Down
2 changes: 1 addition & 1 deletion docs/cloud/deploys/integrations/upstash/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ description:
You can view an example of this integration on
[Github](https://github.com/jetify-com/jetify-deploy-integration/tree/main/devbox-json/upstash)

## Using Upstash Redis with Jetify Cloud[](#using-upstash-redis-with-jetify-cloud "Direct link to Using Upstash Redis with Jetify Cloud")
## Using Upstash Redis with Jetify Cloud[](#using-upstash-redis-with-jetify-cloud "Direct link to Using Upstash Redis with Jetify Cloud")

- [Create a Redis Database](https://upstash.com/docs/redis/overall/getstarted) in Upstash. Select
the Database's name and region, and then click the Create button
Expand Down
6 changes: 3 additions & 3 deletions docs/cloud/deploys/monitoring-deploys/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description:
Jetify Dashboard."
---

## Build Logs[](#build-logs "Direct link to Build Logs")
## Build Logs[](#build-logs "Direct link to Build Logs")

Build logs include all the logs generated when cloning, building, and uploading your project to
Jetify's Docker Registry. You can check the build logs to see why a build or deployment failed, or
Expand All @@ -16,7 +16,7 @@ expanding the Build logs section

![Build logs](./deployment-build-logs.png)

## Runtime Logs[](#runtime-logs "Direct link to Runtime Logs")
## Runtime Logs[](#runtime-logs "Direct link to Runtime Logs")

Runtime logs capture everything that has happened in your application after it is deployed to the
Jetify Cloud. You can use these logs to for testing and debugging server-side errors, or for
Expand All @@ -29,7 +29,7 @@ You can view your Runtime Logs by clicking the **Runtime Logs** tab in your Depl

![Runtime Logs](./deployment-runtime-logs.png)

## Preview URL[](#preview-url "Direct link to Preview URL")
## Preview URL[](#preview-url "Direct link to Preview URL")

In addition to build and runtime logs, Jetify Cloud automatically generates a randomized preview URL
that you can use to test your application, or to share a preview of the deployment with other users
Expand Down
12 changes: 6 additions & 6 deletions docs/cloud/deploys/setup/index.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: "Setting Up Your Deployment"
---

## Configuring your Project[](#configuring-your-project "Direct link to Configuring your Project")
## Configuring your Project[](#configuring-your-project "Direct link to Configuring your Project")

Deploying a project with Jetify Cloud requires the following:

Expand All @@ -14,7 +14,7 @@ Deploying a project with Jetify Cloud requires the following:
running container, so you will need to ensure that your service is listening to that port. We
also recommend setting your service host to `0.0.0.0`.

### Deploying with a devbox.json[](#deploying-with-a-devboxjson "Direct link to Deploying with a devbox.json")
### Deploying with a devbox.json[](#deploying-with-a-devboxjson "Direct link to Deploying with a devbox.json")

Jetify Cloud can use your `devbox.json` to generate a Docker container that will install your
project dependencies and run your projects. In addition to installing your packages, Jetify will
Expand Down Expand Up @@ -55,13 +55,13 @@ and `build` scripts (in that order), and the use `start` as the entrypoint to th

You can preview how Jetify will run the project using `devbox generate dockerfile --for prod`

### Deploying with a Custom Dockerfile[](#deploying-with-a-custom-dockerfile "Direct link to Deploying with a Custom Dockerfile")
### Deploying with a Custom Dockerfile[](#deploying-with-a-custom-dockerfile "Direct link to Deploying with a Custom Dockerfile")

If your repo contains a Dockerfile, Jetify Cloud will use that Dockerfile to deploy your service
(even if the project also contains a devbox.json). Your Dockerfile should define an entrypoint that
Jetify can run upon deploying, as well as listen on port 8080.

## Connecting your Repo[](#connecting-your-repo "Direct link to Connecting your Repo")
## Connecting your Repo[](#connecting-your-repo "Direct link to Connecting your Repo")

Jetify requires you to connect a Github repo in order to deploy your service. To access private
repositories, you will need to install the Devbox Cloud Github app in your repository:
Expand All @@ -76,7 +76,7 @@ repositories, you will need to install the Devbox Cloud Github app in your repos

![Select the Repo for your Jetify Project](./select-repository-for-project.png)

## Choosing an Instance Size[](#choosing-an-instance-size "Direct link to Choosing an Instance Size")
## Choosing an Instance Size[](#choosing-an-instance-size "Direct link to Choosing an Instance Size")

Jetify will default your deployment to the smallest instance size (0.1 CPU + 512MB RAM). To choose a
different size:
Expand All @@ -87,7 +87,7 @@ different size:

Changes to your instance size will take effect on the next deployment.

## Deleting your Project[](#deleting-your-project "Direct link to Deleting your Project")
## Deleting your Project[](#deleting-your-project "Direct link to Deleting your Project")

If you no longer want to deploy your project with Jetify Deploys, you can disable deployments in the
Settings tab of your project.
Loading