diff --git a/README.md b/README.md index 541d4c45a65..26aa154a89a 100644 --- a/README.md +++ b/README.md @@ -16,13 +16,13 @@ In practice, Devbox works similar to a package manager like `yarn` – except the packages it manages are at the operating-system level (the sort of thing you would normally install with `brew` or `apt-get`). With Devbox, you can install over [400,000 package versions](https://www.nixhub.io) from the Nix Package Registry -Devbox was originally developed by [Jetify](https://www.jetify.com) and is internally powered by `nix`. +Devbox was originally developed by [Jetify](https://www.jetify.com) and is internally powered by `nix`. ## Demo You can try out Devbox in your browser using the button below: -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/new) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/tutorial) The example below creates a development environment with `python 2.7` and `go 1.18`, even though those packages are not installed in the underlying machine: diff --git a/docs/app/.envrc b/docs/app/.envrc new file mode 100644 index 00000000000..84fc8e53614 --- /dev/null +++ b/docs/app/.envrc @@ -0,0 +1,7 @@ +# Automatically sets up your devbox environment whenever you cd into this +# directory via our direnv integration: + +eval "$(devbox generate direnv --print-envrc)" + +# check out https://www.jetpack.io/devbox/docs/ide_configuration/direnv/ +# for more details diff --git a/docs/app/docs/cloud/_category_.json b/docs/app/cloud/_category_.json similarity index 100% rename from docs/app/docs/cloud/_category_.json rename to docs/app/cloud/_category_.json diff --git a/docs/app/docs/cloud/cache/authenticating.md b/docs/app/cloud/cache/authenticating.md similarity index 100% rename from docs/app/docs/cloud/cache/authenticating.md rename to docs/app/cloud/cache/authenticating.md diff --git a/docs/app/docs/cloud/cache/index.md b/docs/app/cloud/cache/index.md similarity index 100% rename from docs/app/docs/cloud/cache/index.md rename to docs/app/cloud/cache/index.md diff --git a/docs/app/docs/cloud/cache/prebuilt_cache.md b/docs/app/cloud/cache/prebuilt_cache.md similarity index 100% rename from docs/app/docs/cloud/cache/prebuilt_cache.md rename to docs/app/cloud/cache/prebuilt_cache.md diff --git a/docs/app/docs/cloud/cache/usage.md b/docs/app/cloud/cache/usage.md similarity index 100% rename from docs/app/docs/cloud/cache/usage.md rename to docs/app/cloud/cache/usage.md diff --git a/docs/app/docs/cloud/dashboard/_category_.json b/docs/app/cloud/dashboard/_category_.json similarity index 100% rename from docs/app/docs/cloud/dashboard/_category_.json rename to docs/app/cloud/dashboard/_category_.json diff --git a/docs/app/docs/cloud/dashboard/creating_your_team.md b/docs/app/cloud/dashboard/creating_your_team.md similarity index 92% rename from docs/app/docs/cloud/dashboard/creating_your_team.md rename to docs/app/cloud/dashboard/creating_your_team.md index e04d5a7c7d0..2727be1081d 100644 --- a/docs/app/docs/cloud/dashboard/creating_your_team.md +++ b/docs/app/cloud/dashboard/creating_your_team.md @@ -13,13 +13,13 @@ Users with a free account can upgrade to a paid team on the dashboard anytime. 1. From the Team Selector in the top right of your dashboard, select **Create a New Team** -![New Team](../../../static/img/team_selector.png) +![New Team](../../static/img/team_selector.png) 1. You may be prompted to sign in again. Log in with the same email or Google Account that you used to create your Account. 1. At the bottom of the team selection screen, enter your new Team Name and then click **Create Team** -![Create Team Form](../../../static/img/create_team_form.png) +![Create Team Form](../../static/img/create_team_form.png) 1. Your new team will be created, and you will be automatically switched to your new team. You can now [invite other members](./inviting_members.md) to join your team. diff --git a/docs/app/docs/cloud/dashboard/index.md b/docs/app/cloud/dashboard/index.md similarity index 88% rename from docs/app/docs/cloud/dashboard/index.md rename to docs/app/cloud/dashboard/index.md index c6be6cd66b7..1a9ecad3249 100644 --- a/docs/app/docs/cloud/dashboard/index.md +++ b/docs/app/cloud/dashboard/index.md @@ -5,7 +5,7 @@ sidebar_position: 1 The [Jetify Dashboard](https://cloud.jetify.com) lets you manage your team, projects, and secrets from a single interface. You can use the Dashboard to manage your own hobby projects, or to collaborate with other team members. -![Jetify Dashboard](../../../static/img/jetify_cloud_dashboard.jpeg) +![Jetify Dashboard](../../static/img/jetify_cloud_dashboard.jpeg) You can visit the Jetify Dashboard at [cloud.jetify.com](https://cloud.jetify.com) diff --git a/docs/app/docs/cloud/dashboard/inviting_members.md b/docs/app/cloud/dashboard/inviting_members.md similarity index 85% rename from docs/app/docs/cloud/dashboard/inviting_members.md rename to docs/app/cloud/dashboard/inviting_members.md index 49b34e204cc..5631e45a0c1 100644 --- a/docs/app/docs/cloud/dashboard/inviting_members.md +++ b/docs/app/cloud/dashboard/inviting_members.md @@ -18,21 +18,21 @@ Team members can be added in one of two Roles: 1. In the Jetify Dashboard, navigate to the **Members** tab - ![Members Tab](../../../static/img/members_tab.png) + ![Members Tab](../../static/img/members_tab.png) 2 . To invite a member, enter their email address, and the **Role** you want to assign to them. -![Inviting a Member](../../../static/img/inviting_member.png) +![Inviting a Member](../../static/img/inviting_member.png) 1. Once invited, users will receive an email with instructions on how to join your team. They will show up in the **Members** tab as invited until they accept the invitation: - ![Invited Member](../../../static/img/invited_member.png) + ![Invited Member](../../static/img/invited_member.png) Note that invitations will expire if they are not accepted within 7 days, after which you will need to re-send the invitation. Once they accept the invitation, they will switch to **active** - ![Active Member](../../../static/img/active_member.png) + ![Active Member](../../static/img/active_member.png) ## Removing a Team Member @@ -42,6 +42,6 @@ Removing a team member will remove their access to all projects and secrets in y 2. Click the Options button to the right of the the member’s name 3. Select Delete from the pop up that appears: -![Delete a member](../../../static/img/delete_member.png) +![Delete a member](../../static/img/delete_member.png) 1. Click **OK** on the confirmation window that appears to confirm that you want to remove the member from your team diff --git a/docs/app/docs/cloud/deploys/_category_.json b/docs/app/cloud/deploys/_category_.json similarity index 100% rename from docs/app/docs/cloud/deploys/_category_.json rename to docs/app/cloud/deploys/_category_.json diff --git a/docs/app/docs/cloud/deploys/custom_domains.md b/docs/app/cloud/deploys/custom_domains.md similarity index 85% rename from docs/app/docs/cloud/deploys/custom_domains.md rename to docs/app/cloud/deploys/custom_domains.md index de2ae31d94e..710624f2f94 100644 --- a/docs/app/docs/cloud/deploys/custom_domains.md +++ b/docs/app/cloud/deploys/custom_domains.md @@ -15,13 +15,13 @@ You will need access to the DNS records for your Domain in order to configure it 1. In your project on the Jetify Cloud Dashboard, select **Settings** 1. Scroll down to the **Custom Domain** section on the settings page - ![Custom Domain Section](../../../static/img/custom-domain.png) + ![Custom Domain Section](../../static/img/custom-domain.png) 1. Enter the custom domain name that you would like to use for your project 1. After you click confirm, your custom domain will be set in a pending state. To validate the domain, you will need to add a record to your DNS provider: - ![Pending custom domain](../../../static/img/custom-domain-unknown.png) + ![Pending custom domain](../../static/img/custom-domain-unknown.png) 1. Once the correct records have been added to your DNS provider, your Custom Domain will display an **Issued** status: - ![Custom Domain Issued](../../../static/img/custom-domain-issued.png) + ![Custom Domain Issued](../../static/img/custom-domain-issued.png) ## 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. \ No newline at end of file +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. diff --git a/docs/app/docs/cloud/deploys/index.md b/docs/app/cloud/deploys/index.md similarity index 100% rename from docs/app/docs/cloud/deploys/index.md rename to docs/app/cloud/deploys/index.md diff --git a/docs/app/docs/cloud/deploys/integrations/_category_.json b/docs/app/cloud/deploys/integrations/_category_.json similarity index 100% rename from docs/app/docs/cloud/deploys/integrations/_category_.json rename to docs/app/cloud/deploys/integrations/_category_.json diff --git a/docs/app/docs/cloud/deploys/integrations/index.md b/docs/app/cloud/deploys/integrations/index.md similarity index 100% rename from docs/app/docs/cloud/deploys/integrations/index.md rename to docs/app/cloud/deploys/integrations/index.md diff --git a/docs/app/docs/cloud/deploys/integrations/s3.md b/docs/app/cloud/deploys/integrations/s3.md similarity index 90% rename from docs/app/docs/cloud/deploys/integrations/s3.md rename to docs/app/cloud/deploys/integrations/s3.md index ced580ed732..d215ad0eb9b 100644 --- a/docs/app/docs/cloud/deploys/integrations/s3.md +++ b/docs/app/cloud/deploys/integrations/s3.md @@ -2,7 +2,7 @@ title: Object Storage with AWS S3 --- -[Amazon S3](https://aws.amazon.com/s3/) is an industry leading cloud object storage solution. You can use S3 to store files, media assets, and other objects that are not well suited to storage in a database or KV store. +[Amazon S3](https://aws.amazon.com/s3/) is an industry leading cloud object storage solution. You can use S3 to store files, media assets, and other objects that are not well suited to storage in a database or KV store. You can view an example of this integration on [Github](https://github.com/jetify-com/jetify-deploy-integration/tree/main/devbox-json/s3) @@ -14,7 +14,7 @@ If you don't already have an S3 bucket configured, you will need an [AWS account 2. On the S3 Dashboard, click **Create Bucket**, and give your bucket a name and default region 3. If your files do not need to be accessed by external, public users, leave the **Block all Public Access** button checked. Otherwise configure the permissions to match your needs 4. Once you've finished configuring the bucket, click **Create Bucket** -5. Copy the ARN and save it somewhere secure. +5. Copy the ARN and save it somewhere secure. Once the bucket is created, you'll also need to configure [Bucket Access Policies](https://docs.aws.amazon.com/AmazonS3/latest/userguide/example-bucket-policies.html) and an [IAM User Policy](https://docs.aws.amazon.com/AmazonS3/latest/userguide/walkthrough1.html) to 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. @@ -22,11 +22,11 @@ Once the bucket is created, you'll also need to configure [Bucket Access Policie 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: -* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: +* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: * `AWS_ACCESS_KEY_ID`: The access key for your AWS account * `AWS_SECRET_ACCESS_KEY`: The secret key for your AWS account * `AWS_BUCKET`: The name of the bucket that you will be accessing. -![S3 Jetify Secrets](../../../../static/img/s3-secrets.png) +![S3 Jetify Secrets](../../../static/img/s3-secrets.png) -When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these secrets with any AWS client library (such as boto3 for Python) or via the AWS CLI/SDK itself. \ No newline at end of file +When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these secrets with any AWS client library (such as boto3 for Python) or via the AWS CLI/SDK itself. diff --git a/docs/app/docs/cloud/deploys/integrations/supabase.md b/docs/app/cloud/deploys/integrations/supabase.md similarity index 83% rename from docs/app/docs/cloud/deploys/integrations/supabase.md rename to docs/app/cloud/deploys/integrations/supabase.md index d920f85d43b..21b349040ba 100644 --- a/docs/app/docs/cloud/deploys/integrations/supabase.md +++ b/docs/app/cloud/deploys/integrations/supabase.md @@ -11,18 +11,18 @@ You can view an example of this integration on [Github](https://github.com/jetif 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 personal organization to start. For more details, see the [Supabase Docs](https://supabase.com/docs) -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. +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 -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. +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. -To connect using the API: +To connect using the API: * From your Supabase Project Dashboard, navigate to **Project Settings**, then **API** * In the API Settings pane, copy the Project URL and Secret Service Role key -![Supabase API UI](../../../../static/img/supabase-API.png) -* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: +![Supabase API UI](../../../static/img/supabase-API.png) +* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: * `SUPABASE_URL`: the Project URL for your Supabase DB * `SUPABASE_KEY`: the secret Service Role Key @@ -30,11 +30,11 @@ To connect using the API: If you want to use your Database locally or in a preview environment, you can also set these environment variables for the `dev` and `preview` environment ::: -![Secrets set in the Jetify Cloud](../../../../static/img/supabase-secrets.png) +![Secrets set in the Jetify Cloud](../../../static/img/supabase-secrets.png) -When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these environment variables when configuring your Supabase client. +When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these environment variables when configuring your Supabase client. -For example, if you are connecting from a Python app, you can do something like the following to connect with the Supabase Python client: +For example, if you are connecting from a Python app, you can do something like the following to connect with the Supabase Python client: ```python from supabase import create_client, Client @@ -52,15 +52,15 @@ You can also connect to your database using the standard PostgreSQL Database con To connect via PostgreSQL: * From your Supabase Project Dashboard, navigate to Project Settings, then Database. -* In the Connection Parameters Settings, copy values needed for connection. Your database password will be the password you set when creating your project. -![Supabase Connection Parameters](../../../../static/img/connection_parameters.png) +* In the Connection Parameters Settings, copy values needed for connection. Your database password will be the password you set when creating your project. +![Supabase Connection Parameters](../../../static/img/connection_parameters.png) -* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: +* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: * `POSTGRES_HOST`: Your PostgreSQL Host * `POSTGRES_PORT`: Your PostgreSQL DB Port * `POSTGRES_USER`: Your PostgreSQL Username * `POSTGRES_PASSWORD`: Your PostgreSQL Database Password -![Postgres Secrets](../../../../static/img/postgres-secrets.png) - -When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these environment variables when configuring your PostgreSQL client or connection. \ No newline at end of file +![Postgres Secrets](../../../static/img/postgres-secrets.png) + +When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can use these environment variables when configuring your PostgreSQL client or connection. diff --git a/docs/app/docs/cloud/deploys/integrations/upstash.md b/docs/app/cloud/deploys/integrations/upstash.md similarity index 82% rename from docs/app/docs/cloud/deploys/integrations/upstash.md rename to docs/app/cloud/deploys/integrations/upstash.md index 8bdedfb0dcd..8e31f13e81d 100644 --- a/docs/app/docs/cloud/deploys/integrations/upstash.md +++ b/docs/app/cloud/deploys/integrations/upstash.md @@ -11,22 +11,22 @@ You can view an example of this integration on [Github](https://github.com/jetif * [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 * If you don't already have an Upstash account, you can create a free one to test with Jetify Cloud -* After clicking the Create button, you'll see a page with the connection details for your Database. Copy the Endpoint, Password, and Port -- you'll need these to connect from Jetify Cloud. +* After clicking the Create button, you'll see a page with the connection details for your Database. Copy the Endpoint, Password, and Port -- you'll need these to connect from Jetify Cloud. -![Upstash Dashboard after clicking Create](../../../../static/img/upstash.png) +![Upstash Dashboard after clicking Create](../../../static/img/upstash.png) -* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: +* Go to the Jetify Dashboard for your project, and navigate to Secrets. Create the following Secrets in the `Prod` environment: * `REDIS_HOST`: your Upstash DB Endpoint URL * `REDIS_PASSWORD`: your Upstash DB Password - * `REDIS_PORT`: your Upstash DB Port + * `REDIS_PORT`: your Upstash DB Port :::info If you want to use your Database locally or in a preview environment, you can also set these environment variables for the `dev` and `preview` environment ::: -![Secrets set in the Jetify Cloud](../../../../static/img/upstash-secrets.png) +![Secrets set in the Jetify Cloud](../../../static/img/upstash-secrets.png) -When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can then access them using any redis client. +When you deploy your application, Devbox will automatically set these secrets as env variables in your environment. You can then access them using any redis client. For example, if you are connecting from a Python app, you can do something like the following to connect from a Redis client. @@ -40,4 +40,4 @@ redis_cache = redis.StrictRedis( port=os.getenv('REDIS_PORT'), ssl=True ) -``` \ No newline at end of file +``` diff --git a/docs/app/docs/cloud/deploys/monitoring_deploys.md b/docs/app/cloud/deploys/monitoring_deploys.md similarity index 83% rename from docs/app/docs/cloud/deploys/monitoring_deploys.md rename to docs/app/cloud/deploys/monitoring_deploys.md index 9b9dff76aa1..eaaf702d393 100644 --- a/docs/app/docs/cloud/deploys/monitoring_deploys.md +++ b/docs/app/cloud/deploys/monitoring_deploys.md @@ -9,22 +9,22 @@ Jetify Cloud automatically provides build and runtime logs for each of your depl 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 to identify bottlenecks in the build process. Build logs automatically stream in realtime. -You can view the build logs for a specific deployment by selecting the deployment, and then expanding the Build logs section +You can view the build logs for a specific deployment by selecting the deployment, and then expanding the Build logs section -![Build logs](../../../static/img/deploy-in-progress.png) +![Build logs](../../static/img/deploy-in-progress.png) ## 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 understanding why a given deployment has failed to start. +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 understanding why a given deployment has failed to start. Runtime logs stream in realtime, and Devbox retains the last 24 hours of runtime logs for each of your deployments. You can view your Runtime Logs by clicking the **Runtime Logs** tab in your Deployment Details page: -![Runtime Logs](../../../static/img/runtime-logs.png) +![Runtime Logs](../../static/img/runtime-logs.png) ## 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 and developers. Each deployment receives a unique 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 and developers. Each deployment receives a unique preview URL. -To preview your deployment, click the **View** button on the Deployment Details page. \ No newline at end of file +To preview your deployment, click the **View** button on the Deployment Details page. diff --git a/docs/app/docs/cloud/deploys/secrets.md b/docs/app/cloud/deploys/secrets.md similarity index 100% rename from docs/app/docs/cloud/deploys/secrets.md rename to docs/app/cloud/deploys/secrets.md diff --git a/docs/app/docs/cloud/deploys/setup.md b/docs/app/cloud/deploys/setup.md similarity index 93% rename from docs/app/docs/cloud/deploys/setup.md rename to docs/app/cloud/deploys/setup.md index 86d3616a8f0..02865160267 100644 --- a/docs/app/docs/cloud/deploys/setup.md +++ b/docs/app/cloud/deploys/setup.md @@ -53,18 +53,18 @@ If your repo contains a Dockerfile, Jetify Cloud will use that Dockerfile to dep ## 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: +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: 1. From the Create Project screen, select Continue with Github to sign in with Github -2. Select a Github Org to import your project from. If you are only a member of one org, it will be selected for you by default. +2. Select a Github Org to import your project from. If you are only a member of one org, it will be selected for you by default. 1. If this is your first time importing a project from your org, you will need to install the Devbox Cloud app to provide access to your project -3. Select a Repository to import your repo. If your project is not in the root directory of your repository, you can specify a subdirectory for Jetify to search for your project. +3. Select a Repository to import your repo. If your project is not in the root directory of your repository, you can specify a subdirectory for Jetify to search for your project. -![Select the Repo for your Jetify Project](../../../static/img/newproject-tworepos.png) +![Select the Repo for your Jetify Project](../../static/img/newproject-tworepos.png) ## Choosing an Instance Size -Jetify will default your deployment to the smallest instance size (0.1 CPU + 512MB RAM). To choose a different size: +Jetify will default your deployment to the smallest instance size (0.1 CPU + 512MB RAM). To choose a different size: 1. Navigate to the **Settings** tab of your project 2. Scroll down to **Deployments** diff --git a/docs/app/cloud/devspace/_category_.json b/docs/app/cloud/devspace/_category_.json new file mode 100644 index 00000000000..d9e4b62cd87 --- /dev/null +++ b/docs/app/cloud/devspace/_category_.json @@ -0,0 +1,4 @@ +{ + "label": "Jetify Devspace", + "position": 1 +} diff --git a/docs/app/cloud/devspace/faq.md b/docs/app/cloud/devspace/faq.md new file mode 100644 index 00000000000..e37fb93a253 --- /dev/null +++ b/docs/app/cloud/devspace/faq.md @@ -0,0 +1,42 @@ +--- +title: FAQ +sidebar_position: 6 +hide_title: false +--- + +## What is Jetify Devspace? + +Jetify Devspace is a cloud-based development environment that can be customized and preconfigured using Devbox. Your Devspace is fully managed by Jetify, so you don't need to worry about setting up servers or infrastructure to get started. + +## What size instances are available for Jetify Devspace? + +Currently, all Jetify Devspace are configured with the following default specs: + +* 4 vCPUs +* 16 GB RAM +* 10 GB Home Dir SSD + +## Can I request a custom instance size? + +We are working on adding support for more instance sizes, including the ability to configure custom sizes. Stay tuned for updates! + +## Can I create an instance with a GPU? + +GPU support is coming soon! + +## What are the limitations for the Jetify Devspace Free Tier? + +Our Free Tier comes with the following limitations per user: + +* 2 Devspaces +* 25 active hours per month +* 15-minute inactivity timeout +* 4-hours maximum runtime per Devspace + +## Do you have offers for Education and Open Source projects? + +If you're interested in using Jetify Devspace for Education or Open Source projects, please reach out to us at [help@jetify.com](mailto:help@jetify.com) to discuss your use case and needs! + +## Do you offer self-hosted or Enterprise solutions? + +We're looking for early design partners for our self-hosted and Enterprise solutions. If you're interested in exploring Jetify Devspace for your enterprise, please reach out to us at [sales@jetify.com](mailto:sales@jetify.com) diff --git a/docs/app/cloud/devspace/index.md b/docs/app/cloud/devspace/index.md new file mode 100644 index 00000000000..70a0fad06da --- /dev/null +++ b/docs/app/cloud/devspace/index.md @@ -0,0 +1,68 @@ +--- +title: Quickstart +sidebar_position: 1 +hide_title: false +--- + +Jetify Devspace let you spin up reproducible cloud development environments in your browser in seconds. Jetify Devspace is powered by [Devbox](/devbox/docs), so you can run your environment on any machine. You can launch any + +Let's launch our first Dev Environment in Jetify Devspace. + +## Step 1: Launch Jetify Devspace from Github + +You can launch any Github Repo in a Jetify Sandbox by prepend the repo URL with: + +```bash +https://cloud.jetify.com/new/ +``` + +For example, to launch the [Devbox repo](https://github.com/jetify-com/devbox), open the following URL in your browser + + [https://cloud.jetify.com/new/github.com/jetify-com/devbox](https://cloud.jetify.com/new/github.com/jetify-com/devbox) + +:::tip + If you need some inspiration, you can also launch one of our [templates](/devbox/docs/devbox_examples) projects to get started +::: + +You can also launch a new Devspace by navigating to your [Dashboard](https://cloud.jetify.com/dashboard) and clicking on the `New Devspace` button. + +## Step 2: Customize your Environment with Devbox + +You can customize your Jetify Devspace with over 100,000 Nix packages in seconds using Devbox. + +If your project doesn't already have a devbox.json, you can initialize one with: + +```bash +devbox init +``` + +Once initialized, you can install your packages using: + +```bash +devbox add @ +``` + +For example, to install `python 3.11`, you can run: + +```bash +devbox add python@3.11 +``` + +You can find packages to install using `devbox search `, or by searching in your browser with [Nixhub](https://www.nixhub.io) + +Packages you install will be added to your `devbox.json` file. You can also use this `devbox.json` file configure your environment with [scripts](/devbox/docs/guides/scripts), [services](/devbox/docs/guides/services), and more + +For further reading on how to install packages with Devbox, see: + +* [Devbox Quickstart](/devbox/docs/quickstart) +* [Devbox CLI Reference](/devbox/docs/cli_reference/devbox) + +## Step 3: Save your Dev Environment with `devbox.json` + +Once you've customized your environment, you can save your Dev Environment config to source control by checking in your `devbox.json` and `devbox.lock` files. These files can be used to recreate your environment on Jetify Devspace, or on any other machine that has devbox installed. + +You can also use this file to configure initialization hooks, scripts, services, and environment variables for your project. For further reading, see: + +* [Devbox Configuration Reference](/devbox/docs/configuration) +* [Devbox Script](/devbox/docs/guides/scripts) +* [Devbox Services](/devbox/docs/guides/services) diff --git a/docs/app/cloud/devspace/managing_devspaces.md b/docs/app/cloud/devspace/managing_devspaces.md new file mode 100644 index 00000000000..66ad4633eaf --- /dev/null +++ b/docs/app/cloud/devspace/managing_devspaces.md @@ -0,0 +1,30 @@ +--- +title: Managing Devspace +sidebar_position: 3 +hide_title: false +--- +Devspaces that you've previously created can be managed from the Jetify Cloud dashboard. You can use the dashboard start, stop, and delete your previous Devspace instances. + +## Accessing the Dashboard + +To access Devspace in your dashboard, navigate to [cloud.jetify.com](https://cloud.jetify.com) and log in with your Jetify account. Once you select an Org, you will can view all the Devspaces that you have created within that org on the org page. + +If you've created any projects in the org, you can also navigate to the project and select the Devspace tab to view all your instances in that project. + +## Stopping and Starting Devspace + +Your Devspaces are automatically stopped after 15 minutes of user inactivity. This is to help you save resources, and avoid being billed for unused CPU time. + +If you want to manually stop your instance, click on the `Options` button on the Devspace that you want to stop, and then click on the `Stop` button. Your package store and project data will be saved, so you can quickly resume your work when you restart the Devspace. + +:::info +Stopped instances are not billed for CPU usage, but you may be billed for storage usage in excess of the free tier. +::: + +To restart your Devspace, click the option button on the cloud box you want to start, and then click the "Start" button. This will relaunch with the Home directory and packages from your previous session. + +## Deleting Devspaces + +By default, Devspaces are deleted if they are not used for more than 14 consecutive days. This is to help you save storage costs, and avoid being billed for unused disks. + +If you are done with a Devspace, you can delete it by clicking on the `Options` button on the instance that you want to delete, and then clicking on the `Delete` button. This will permanently delete all data associated with the Devspace. diff --git a/docs/app/cloud/devspace/sharing_devspaces.md b/docs/app/cloud/devspace/sharing_devspaces.md new file mode 100644 index 00000000000..d9404004fae --- /dev/null +++ b/docs/app/cloud/devspace/sharing_devspaces.md @@ -0,0 +1,33 @@ +--- +title: Sharing Devspace +sidebar_position: 4 +hide_title: false +--- + +**Jetify Projects** are a great way to share configuration and secrets with your team. A project can store repository settings and secrets that are shared across all Devspace users in the project. For example, you can configure a project for a Backend API with the database parameters, API keys, and other secrets. When a user launches Jetify Devspace in the project, they will automatically have access to the project's configuration and secrets. + +## Creating a Project + +To create a project: + +1. Navigate to the **Projects** tab in the Jetify Dashboard +2. Click on the `Create New` button on the top right corner of the page +3. In the modal that appears, give the project a name, and then click "Create Project" +4. In the new project, click "Connect with Github" to connect the project to a Github repository +5. Select the account and repository to link to the project. + +Once the project is linked to a repository, developers can automatically create a new Devspace for that repository by navigating to the project and clicking on the `New Devspace` button. + +## Sharing Secrets + +Jetify Projects can store secrets with Jetify Secrets that are shared across all Devspaces in the project. New Jetify Devspace instances will automatically use the `dev` namespace when accessing secrets. + +To add a secret to a project: + +1. Navigate to the project in the Jetify Dashboard +2. Click on the `Secrets` tab +3. In the New Secrets form, provide a key and value for the secret, and then click "Add Secret" + +Jetify will automatically add the secrets to any session that is launched in the project. Note that if a Devspace instance is currently running when you add a secret, you will need to restart it to access the new secret. + +For more information on managing secrets, see the [Jetify Secrets](../../secrets) guide. diff --git a/docs/app/cloud/devspace/start_a_devspace.md b/docs/app/cloud/devspace/start_a_devspace.md new file mode 100644 index 00000000000..eb82f7191ca --- /dev/null +++ b/docs/app/cloud/devspace/start_a_devspace.md @@ -0,0 +1,44 @@ +--- +title: Starting Jetify Devspaces +sidebar_position: 2 +hide_title: false +--- + +## From Your Dashboard + +If you have not created a Devspace before, you will need to link your Github Account first in order to grant us permissions to access your repositories. + +1. Navigate to the [Jetify Dashboard](https://cloud.jetify.com/dashboard) and clicking on the "**Connect Github Repository**" button. +2. After signing in with Github, you will need to give the Jetify Cloud Github App permissions to access and create repositories on your account. + +To create a new Jetify Devspace from your [Jetify Dashboard](https://cloud.jetify.com/): + +1. Click "**+ Create New**" button on the top right corner of the page. +2. In the modal that appears, enter the URL of the Github repository you want to use for your Devspace. +3. Click "**Create Devspace**" to start your new Devspace + +![Create New Devspace](/img/dashboard_create_new_devspace.png) + +Once you've created a Devspace, you can access it from the Devspace list in your Dashboard. + +## With a Github URL + +You can start Jetify Devspace from any Github Repo by prepending the repo URL with: + +```bash +https://cloud.jetify.com/new/ +``` + +For example, you can open the Devbox repo in a Jetify Devspace by opening the following URL in your browser: + +```bash +https://cloud.jetify.com/new/github.com/jetify-com/devbox +``` + +## From a Template + +A full list of available templates and projects can be found in the [Devbox Examples](/devbox/docs/devbox_examples/) page of our documentation. + +## From a Project + +If you've already created a project in the Jetify Dashboard, you can start a new Devspace from the project by navigating to the project and clicking on the "**+ Create New**" button. This will create a new Devspace using the project's configuration and secrets. diff --git a/docs/app/docs/cloud/faq.md b/docs/app/cloud/faq.md similarity index 85% rename from docs/app/docs/cloud/faq.md rename to docs/app/cloud/faq.md index cdf23be0774..f8cfdc71405 100644 --- a/docs/app/docs/cloud/faq.md +++ b/docs/app/cloud/faq.md @@ -17,7 +17,7 @@ To share secrets and access to deployments with other team members, you will nee ## How do Jetify Cloud Plans work? -Jetify Cloud Plans are available for a monthly platform fee, and allow you to share your Jetify Cloud resources with your team, along with increased support levels. All plans include usage credits equal to the monthly platform fee, which are billed at standard usage rates. +Jetify Cloud Plans are available for a monthly platform fee, and allow you to share your Jetify Cloud resources with your team, along with increased support levels. All plans include usage credits equal to the monthly platform fee, which are billed at standard usage rates. For more details, see our [**pricing**](https://www.jetify.com/cloud/pricing) page. @@ -25,17 +25,29 @@ For more details, see our [**pricing**](https://www.jetify.com/cloud/pricing) pa We offer private instances and other features as part of our Enterprise Plan. [Contact us](https://calendly.com/d/3rd-bhp-qym/meet-with-the-jetify-team) so we can build a solution that meets your needs. -## How does pricing for Jetify Deploys work? + + +## What are the specs of Jetify Devspace? + +Devspaces by default have: + +* 4 Dedicated vCPUs +* 16 GB of RAM +* 10 GB of user SSD Storage + +Larger instances or more resources are available on request for paid customers! Contact us at [**help@jetify.com**](mailto:help@jetify.com?subject=Request More Resources) + ## How does pricing for Jetify Cache work? The Jetify Prebuilt Cache is included in your subscription for no additional cost. Jetify Private Cache costs $0.60/GB of storage per month for the first 50 GB, and $0.50/GB per month after that. Jetify Private cache does not charge for bandwidth or downloads. -## What size instances are available for Jetify Deploys? + + ## My project needs a custom instance size or scaling policy We can customize Jetify Deployments for your project's needs. [Contact us](https://calendly.com/d/3rd-bhp-qym/meet-with-the-jetify-team) for help with a customized solution. diff --git a/docs/app/docs/cloud/index.md b/docs/app/cloud/index.md similarity index 65% rename from docs/app/docs/cloud/index.md rename to docs/app/cloud/index.md index 3e910856845..d1f791ff988 100644 --- a/docs/app/docs/cloud/index.md +++ b/docs/app/cloud/index.md @@ -17,17 +17,20 @@ Jetify Cloud is currently available in Early Access. We're actively working on a Jetify Cloud currently includes: -**[Jetify Cache](./cache/index.md)**: Provides a secure, private cache to share packages across all your Devbox projects and environments, whether sourced from Nixpkgs or Flakes. Avoid rebuilding custom packages locally or in CI. +**[Jetify Devspace](./devspace/index.md):** Create isolated, reproducible development environments for your team. Use Devbox to define the packages and configuration for your environment, and access your devspace anywhere from the browser. -**[Jetify Secrets](./secrets/index.md)**: Securely store secrets and variables for all of your environments, and automatically synchronize them with your Devbox Shells and Scripts +**[Jetify Cache](./cache/index.md)**: Provides a secure, private cache to share packages across all your Devbox projects and environments, whether sourced from Nixpkgs or Flakes. Avoid rebuilding custom packages locally or in CI. -**[Jetify Deploys](./deploys/index.md)**: Deploy Devbox projects as autoscaling, stateless services. See your changes live and in production as soon as you push to your repository, no extra DevOps or Config required. +**[Jetify Secrets](./secrets/index.md)**: Securely store secrets and variables for all of your environments, and automatically synchronize them with your Devbox Shells and Scripts. + + More features are coming soon, keep an eye on our [**blog**](https://www.jetify.com/blog) for future updates! ## Getting Started -- Learn how to [**create your team**](./dashboard/creating_your_team.md) and [**invite members**](./dashboard/inviting_members.md) +- Create your first [**Jetify Devspace**](./devspace/index.md) and start developing in the cloud - Speed up your dev environments with [**Jetify Cache**](./cache/index.md) - Integrate Secrets with your Devbox project using [**Jetify Secrets**](./secrets/index.md) -- Learn how to deploy your application with [**Jetify Deploys**](./deploys/index.md) +- Learn how to [**create your team**](./dashboard/creating_your_team.md) and [**invite members**](./dashboard/inviting_members.md) + diff --git a/docs/app/docs/cloud/secrets/_category_.json b/docs/app/cloud/secrets/_category_.json similarity index 100% rename from docs/app/docs/cloud/secrets/_category_.json rename to docs/app/cloud/secrets/_category_.json diff --git a/docs/app/docs/cloud/secrets/dashboard_secrets.md b/docs/app/cloud/secrets/dashboard_secrets.md similarity index 92% rename from docs/app/docs/cloud/secrets/dashboard_secrets.md rename to docs/app/cloud/secrets/dashboard_secrets.md index 24c498bd2a8..9a440ed8de2 100644 --- a/docs/app/docs/cloud/secrets/dashboard_secrets.md +++ b/docs/app/cloud/secrets/dashboard_secrets.md @@ -16,7 +16,7 @@ To manage secrets from the Jetify Cloud Dashboard, you must first: 1. From the Jetify Dashboard, select the project whose secrets you want to manage 1. Navigate to the Secrets tab of the Jetify Dashboard - ![Jetify Dashboard Secrets Tab](../../../static/img/secrets_tab.png) + ![Jetify Dashboard Secrets Tab](../../static/img/secrets_tab.png) 1. To create a new secret, enter the key name of the secret, along with the value that you want to set in the form. Note that secrets are set as environment variables, so the key name must be a valid environment variable name. 1. You can also use the Environment checkboxes to set the secret for a specific environment. By default, secrets are set for the `Development` environment, but you can also set secrets for a `Preview` and `Prod` environment. 1. To add multiple secrets at one time, click the **Add Another** button @@ -26,7 +26,7 @@ To manage secrets from the Jetify Cloud Dashboard, you must first: You can update or manage secrets by clicking the edit button next to the secret that you want to update. This will open a modal where you can update the value of the secret, or delete the secret entirely. -![Editing Secrets](../../../static/img/edit_secrets.png) +![Editing Secrets](../../static/img/edit_secrets.png) ## Further Reading diff --git a/docs/app/docs/cloud/secrets/index.md b/docs/app/cloud/secrets/index.md similarity index 97% rename from docs/app/docs/cloud/secrets/index.md rename to docs/app/cloud/secrets/index.md index 8e9e3987074..e9b7f988d3e 100644 --- a/docs/app/docs/cloud/secrets/index.md +++ b/docs/app/cloud/secrets/index.md @@ -5,7 +5,7 @@ sidebar_position: 1 Jetify Secrets is a secure secrets management service that lets you store and access secrets for your projects. Secrets are encrypted and stored in the cloud, and are automatically accessed by your project’s Devbox environment whenever you start a shell, run a script, or start a service. -![Using Devbox Secrets](../../../static/img/secrets.gif) +![Using Devbox Secrets](../../static/img/secrets.gif) ## Key Concepts diff --git a/docs/app/docs/cloud/secrets/secrets_cli.md b/docs/app/cloud/secrets/secrets_cli.md similarity index 93% rename from docs/app/docs/cloud/secrets/secrets_cli.md rename to docs/app/cloud/secrets/secrets_cli.md index a3f9c102bb8..3e5e10318f3 100644 --- a/docs/app/docs/cloud/secrets/secrets_cli.md +++ b/docs/app/cloud/secrets/secrets_cli.md @@ -9,9 +9,9 @@ If you don't already have Devbox installed, see our [Quickstart](https://www.jet ## Authenticating with Devbox -You can authenticate with Jetify Cloud by running `devbox secrets auth login`. This will launch the browser authentication flow to sign into Jetify Cloud. +You can authenticate with Jetify Cloud by running `devbox auth login`. This will launch the browser authentication flow to sign into Jetify Cloud. -![Auth Page](../../../static/img/jetify_auth.jpeg) +![Auth Page](../../static/img/jetify_auth.jpeg) Once you complete the authentication flow and select a team, the Devbox CLI will configure itself to use the team you selected @@ -134,5 +134,5 @@ You can download from a specific environment using the `--environment` flag: ## Further Reading -- [Devbox Secrets CLI Reference](../../cli_reference/devbox_secrets.md) +- [Devbox Secrets CLI Reference](/devbox/docs/cli_reference/devbox_secrets) - [Managing Secrets from the Dashboard](../dashboard_secrets) diff --git a/docs/app/cloud/sidebar.ts b/docs/app/cloud/sidebar.ts new file mode 100644 index 00000000000..8c3d39ea3ef --- /dev/null +++ b/docs/app/cloud/sidebar.ts @@ -0,0 +1,70 @@ +import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; + +const cloudSidebar: SidebarsConfig = { + sidebar: [ + { + type: "doc", + id: "index", + }, + { + type: "category", + label: "Jetify Devspace", + collapsible: false, + items: [ + { + type: "autogenerated", + dirName: "devspace", + }, + ], + }, + { + type: "category", + label: "Secrets", + collapsible: false, + items: [ + { + type: "autogenerated", + dirName: "secrets", + }, + ], + }, + { + type: "category", + label: "Package Cache", + collapsible: false, + items: [ + { + type: "autogenerated", + dirName: "cache", + }, + ], + }, + { + type: "category", + label: "Teams and Projects", + collapsible: false, + items: [ + { + type: "autogenerated", + dirName: "dashboard", + }, + ], + }, + // { + // type: "category", + // label: "Deploying your Project with Jetify Deployments", + // items: [ + // { + // type: "autogenerated", + // dirName: "cloud/deploys", + // }, + // ], + // }, + { + type: "doc", + id: "faq", + }, + ], +}; + +export default cloudSidebar.sidebar; diff --git a/docs/app/cloud_sidebars.js b/docs/app/cloud_sidebars.js new file mode 100644 index 00000000000..dae19824e8e --- /dev/null +++ b/docs/app/cloud_sidebars.js @@ -0,0 +1,23 @@ +/** + * Creating a sidebar enables you to: + - create an ordered group of docs + - render a sidebar for each doc of that group + - provide next/previous navigation + + The sidebars can be generated from the filesystem, or explicitly defined here. + + Create as many sidebars as you want. + */ + +// @ts-check + +/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */ +const sidebars = { + // By default, Docusaurus generates a sidebar from the docs folder structure + // tutorialSidebar: [{ type: 'autogenerated', dirName: '.' }], + + // But you can create a sidebar manually + cloudSidebar: require("./cloud/sidebar"), +}; + +export default sidebars; diff --git a/docs/app/docs/configuration.md b/docs/app/docs/configuration.md index d4523f0b240..6036f03db25 100644 --- a/docs/app/docs/configuration.md +++ b/docs/app/docs/configuration.md @@ -180,6 +180,34 @@ For example, you could set variable `$FOO` to `bar` by adding the following to y Currently, you can only set values using string literals, `$PWD`, and `$PATH`. Any other values with environment variables will not be expanded when starting your shell. +### Env From + +Env from takes a string or list of strings for loading environment variables into your shells and scripts. Currently it supports loading from two sources: .env files, and Jetify Secrsts. + +#### .env Files + +You can load environment variables from a `.env` file by adding the path to the file in the `env_from` field. This is useful for loading secrets or other sensitive information that you don't want to store in your `devbox.json`. + +```json +{ + "env_from": "path/to/.env" +} +``` + +This will load the environment variables from the `.env` file into your shell when you run `devbox shell` or `devbox run`. Note that environment variables set in the `.env` file will be overridden if the same variable is set directly in your `devbox.json` + +#### Jetify Secrets + +You can securely load secrets from Jetify Secrets by running `devbox secrets init` and creating a project in Jetify Cloud. This will add the `jetpack-cloud` field to `env_from` in your project. + +```json +{ + "env_from": "jetpack-cloud" +} +``` + +Note that setting secrets securetly with Jetify Secrets requires a Jetify Cloud account. For more information, see the [Jetify Secrets](/cloud/docs/secrets/) guide. + ### Shell The Shell object defines init hooks and scripts that can be run with your shell. Right now two fields are supported: `init_hook`, which run a set of commands every time you start a devbox shell, and `scripts`, which are commands that can be run using `devbox run` diff --git a/docs/app/docs/contributor-quickstart.md b/docs/app/docs/contributor-quickstart.md index ddbe7012a2b..31090c457ae 100644 --- a/docs/app/docs/contributor-quickstart.md +++ b/docs/app/docs/contributor-quickstart.md @@ -80,10 +80,10 @@ Devbox requires the [Nix Package Manager](https://nixos.org/download.html). If N ### Boost your dev environment with Jetify Cloud -* **[Jetify Secrets](./cloud/secrets/index.md):** Securely store and access your secrets and environment variables in your Devbox projects. -* **[Jetify Deploys](./cloud/deploys/index.md):** Deploy your Devbox projects as autoscaling services with a single command. -* **[Jetify Cache](./cloud/cache/index.md):** Share and cache packages across all your Devbox projects and environments. -* **[Jetify Prebuilt Cache](./cloud/cache/prebuilt_cache.md):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. +* **[Jetify Secrets](/cloud/docs/secrets/):** Securely store and access your secrets and environment variables in your Devbox projects. +* **[Jetify Deploys](/cloud/docs/deploys/):** Deploy your Devbox projects as autoscaling services with a single command. +* **[Jetify Cache](/cloud/docs/cache/):** Share and cache packages across all your Devbox projects and environments. +* **[Jetify Prebuilt Cache](/cloud/docs/cache/):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. ### Get Involved * **[Join our Discord Community](https://discord.gg/jetify):** Chat with the development team and our growing community of Devbox users. diff --git a/docs/app/docs/devbox_cloud/index.mdx b/docs/app/docs/devbox_cloud/index.mdx index 795fe17352d..e9c0da05af5 100644 --- a/docs/app/docs/devbox_cloud/index.mdx +++ b/docs/app/docs/devbox_cloud/index.mdx @@ -16,7 +16,7 @@ Devbox.sh provides a sandboxed playground environment for you to learn how Devbo You can launch a new playground from your browser by visiting [devbox.sh](https://devbox.sh), or click the button below to launch a quickstart shell: -[![Open in Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/new) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/new) Each Devbox playground comes with the Devbox CLI, Nix, and several common packages preinstalled, so you can easily run projects that include a `devbox.json` @@ -67,12 +67,12 @@ Click on the `Open in Desktop` button on the top right corner, which will open u If your project uses Devbox, you can make it easy for developers to test your project in a Devbox playground by adding the `Open in Devbox.sh` badge to your repo -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/github.com/jetify-com/devbox) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/github.com/jetify-com/devbox) Add the following code to your README.md: ```md -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/{path_to_repo}) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/{path_to_repo}) ``` ## More Info diff --git a/docs/app/docs/devbox_examples/databases/mariadb.md b/docs/app/docs/devbox_examples/databases/mariadb.md index 0823fa126c5..dd1b3c87915 100644 --- a/docs/app/docs/devbox_examples/databases/mariadb.md +++ b/docs/app/docs/devbox_examples/databases/mariadb.md @@ -5,7 +5,7 @@ MariaDB can be automatically configured for your dev environment by Devbox via t [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/databases/mariadb) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/mariadb) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/mariadb) ## Adding MariaDB to your Shell @@ -24,14 +24,15 @@ You can manually add the MariaDB Plugin to your `devbox.json` by adding it to yo "plugin:mariadb" ] ``` + This will install the latest version of MariaDB. You can find other installable versions of MariaDB by running `devbox search mariadb`. You can also view the available versions on [Nixhub](https://www.nixhub.io/packages/mariadb) ## MariaDB Plugin Support Devbox will automatically create the following configuration when you run `devbox add mariadb`. You can view the full configuration by running `devbox info mariadb` - ### Services + * mariadb You can use `devbox services up|stop mariadb` to start or stop the MariaDB Server. @@ -82,4 +83,4 @@ You can disable the MariaDB plugin by running `devbox add mariadb --disable-plug } } } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/databases/mongodb.md b/docs/app/docs/devbox_examples/databases/mongodb.md index 1f1202d7abf..343006c885b 100644 --- a/docs/app/docs/devbox_examples/databases/mongodb.md +++ b/docs/app/docs/devbox_examples/databases/mongodb.md @@ -6,7 +6,7 @@ MongoDB is a popular NoSQL database that is available on Nixpkgs. You can config ## Adding MongoDB to your Shell -You can start by adding the mongodb server to your project by running `devbox add mongodb`. We also recommend adding the MongoDB shell for interacting with your database using `devbox add mongosh`: +You can start by adding the mongodb server to your project by running `devbox add mongodb`. We also recommend adding the MongoDB shell for interacting with your database using `devbox add mongosh`: ```json "packages": [ @@ -23,7 +23,7 @@ You can add the MongoDB Plugin to your `devbox.json` by adding it to your `inclu ] ``` -Adding these packages and the plugin will configure Devbox for working with MongoDB. +Adding these packages and the plugin will configure Devbox for working with MongoDB. ## Starting the MongoDB Service @@ -38,7 +38,7 @@ processes: max_restarts: 5 ``` -You can configure this service by modifying the environment variable shown below. +You can configure this service by modifying the environment variable shown below. If you want to create your own version of the mongodb service, you can create a process-compose.yaml in your project's root, and define a new process named `mongodb`. For more details, see the [process-compose documentation](https://f1bonacc1.github.io/process-compose/) diff --git a/docs/app/docs/devbox_examples/databases/mysql.md b/docs/app/docs/devbox_examples/databases/mysql.md index f79b3d272f9..a052ff704cb 100644 --- a/docs/app/docs/devbox_examples/databases/mysql.md +++ b/docs/app/docs/devbox_examples/databases/mysql.md @@ -5,7 +5,7 @@ MySQL can be automatically configured for your dev environment by Devbox via the [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/databases/mysql) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/github.com/jetify-com/devbox/?folder=examples/databases/mysql) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/mysql) ## Adding MySQL to your Shell @@ -33,8 +33,8 @@ This will install the latest version of MySQL. You can find other installable ve Devbox will automatically create the following configuration when you run `devbox add mysql80` or `devbox add mysql57`. You can view the full configuration by running `devbox info mysql` - ### Services + * mysql You can use `devbox services up|stop mysql` to start or stop the MySQL Server. @@ -85,4 +85,4 @@ You can disable the built-in MySQL plugin using `devbox add mysql80 --disable-pl } } } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/databases/postgres.md b/docs/app/docs/devbox_examples/databases/postgres.md index 425e271bdc8..d3404c37197 100644 --- a/docs/app/docs/devbox_examples/databases/postgres.md +++ b/docs/app/docs/devbox_examples/databases/postgres.md @@ -5,7 +5,7 @@ PostgreSQL can be automatically configured by Devbox via the built-in Postgres P [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/databases/postgres) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/postgres) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/postgres) ## Adding Postgres to your Shell @@ -30,6 +30,7 @@ This will install the latest version of Postgres. You can find other installable Devbox will automatically create the following configuration when you run `devbox add postgresql`: ### Services + * postgresql You can use `devbox services start|stop postgresql` to start or stop the Postgres server in the background. @@ -44,14 +45,19 @@ This variable tells PostgreSQL which directory to use for creating and storing d ### NOTES 1. To initialize PostgreSQL run: + ```sh initdb ``` -3. You also need to create a user using: + +1. You also need to create a user using: + ```sh createuser --interactive ``` -5. (OPTIONAL) If the user has no permissions to create or drop a database, you also need to create a database using: + +1. (OPTIONAL) If the user has no permissions to create or drop a database, you also need to create a database using: + ```sh createdb ``` @@ -81,4 +87,4 @@ You can disable the Postgres plugin by running `devbox add postgresql --disable- } } } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/databases/redis.md b/docs/app/docs/devbox_examples/databases/redis.md index 0072648aebb..3aaf97be1be 100644 --- a/docs/app/docs/devbox_examples/databases/redis.md +++ b/docs/app/docs/devbox_examples/databases/redis.md @@ -6,7 +6,7 @@ Redis can be configured automatically using Devbox's built in Redis plugin. This [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/databases/redis) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/redis) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/redis) ## Adding Redis to your shell @@ -36,7 +36,6 @@ The following helper files will be created in your project directory: * \{PROJECT_DIR\}/devbox.d/redis/redis.conf - ### Environment Variables ```bash @@ -65,4 +64,4 @@ You can disable the Redis plugin by running `devbox add redis --disable-plugin`, } } } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/databases/valkey.md b/docs/app/docs/devbox_examples/databases/valkey.md index 551ed265b22..4ce04ea5052 100644 --- a/docs/app/docs/devbox_examples/databases/valkey.md +++ b/docs/app/docs/devbox_examples/databases/valkey.md @@ -6,7 +6,7 @@ Valkey can be configured automatically using Devbox's built in Valkey plugin. Th [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/databases/valkey) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/valkey) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/valkey) ## Adding Valkey to your shell @@ -36,7 +36,6 @@ The following helper files will be created in your project directory: * \{PROJECT_DIR\}/devbox.d/valkey/valkey.conf - ### Environment Variables ```bash @@ -65,4 +64,4 @@ You can disable the Valkey plugin by running `devbox add valkey --disable-plugin } } } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/languages/csharp.md b/docs/app/docs/devbox_examples/languages/csharp.md index 29e8a60a3c8..2df0fff887d 100644 --- a/docs/app/docs/devbox_examples/languages/csharp.md +++ b/docs/app/docs/devbox_examples/languages/csharp.md @@ -6,7 +6,7 @@ C# and .NET projects can be easily generated in Devbox by adding the dotnet SDK [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/csharp) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/dotnet) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/csharp) ## Adding .NET to your project @@ -17,6 +17,7 @@ C# and .NET projects can be easily generated in Devbox by adding the dotnet SDK "dotnet-sdk@latest" ], ``` + This will install the latest version of the dotnet SDK. You can find other installable versions of the dotnet SDK by running `devbox search dotnet-sdk`. If you need a specific version of the .NET SDK, you can search on [Nixhub](https://www.nixhub.io/search?q=dotnet) diff --git a/docs/app/docs/devbox_examples/languages/elixir.md b/docs/app/docs/devbox_examples/languages/elixir.md index 8d30bf4e22e..12ad61972e0 100644 --- a/docs/app/docs/devbox_examples/languages/elixir.md +++ b/docs/app/docs/devbox_examples/languages/elixir.md @@ -6,8 +6,7 @@ Elixir can be configured to install Hex and Rebar dependencies in a local direct [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/elixir/elixir_hello) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/elixir) - +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/elixir/) ## Adding Elixir to your project diff --git a/docs/app/docs/devbox_examples/languages/fsharp.md b/docs/app/docs/devbox_examples/languages/fsharp.md index 8f63a035dce..81816ffbf82 100644 --- a/docs/app/docs/devbox_examples/languages/fsharp.md +++ b/docs/app/docs/devbox_examples/languages/fsharp.md @@ -6,7 +6,7 @@ F# and .NET projects can be easily generated in Devbox by adding the dotnet SDK [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/fsharp) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/fsharp) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/fsharp) ## Adding .NET to your project @@ -17,6 +17,7 @@ F# and .NET projects can be easily generated in Devbox by adding the dotnet SDK "dotnet-sdk@latest" ], ``` + This will install the latest version of the dotnet SDK. You can find other installable versions of the dotnet SDK by running `devbox search dotnet-sdk`. You can also view the available versions on [Nixhub](https://www.nixhub.io/search?q=dotnet) ## Creating a new F# Project diff --git a/docs/app/docs/devbox_examples/languages/go.md b/docs/app/docs/devbox_examples/languages/go.md index 0629c9b5f1a..ec9381ff3d7 100644 --- a/docs/app/docs/devbox_examples/languages/go.md +++ b/docs/app/docs/devbox_examples/languages/go.md @@ -6,7 +6,7 @@ Go projects can be run in Devbox by adding the Go SDK to your project. If your p [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/go/hello-world) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/go) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/go) ## Adding Go to your Project diff --git a/docs/app/docs/devbox_examples/languages/java.md b/docs/app/docs/devbox_examples/languages/java.md index 4b7548a8d48..485f50ba561 100644 --- a/docs/app/docs/devbox_examples/languages/java.md +++ b/docs/app/docs/devbox_examples/languages/java.md @@ -28,7 +28,7 @@ Other distributions of the JDK (such as OracleJDK and Eclipse Temurin) are avail [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/java/gradle/hello-world) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/java-gradle) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/java-gradle) Gradle is a popular, multi-language build tool that is commonly used with JVM projects. To setup an example project using Gradle, follow the instructions below: @@ -81,7 +81,7 @@ An example `devbox.json` would look like the following: [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/java/maven/hello-world) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/java-maven) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/new/templates/java-maven) Maven is an all-in-one CI-CD tool for building testing and deploying Java projects. To setup a sample project with Java and Maven in devbox follow the steps below: diff --git a/docs/app/docs/devbox_examples/languages/nodejs.md b/docs/app/docs/devbox_examples/languages/nodejs.md index 8cd99fd7b63..3f6ea88cb21 100644 --- a/docs/app/docs/devbox_examples/languages/nodejs.md +++ b/docs/app/docs/devbox_examples/languages/nodejs.md @@ -6,7 +6,7 @@ Most NodeJS Projects will install their dependencies locally using NPM or Yarn, [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/nodejs) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/node-npm) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/nodejs) ## Adding NodeJS to your Shell @@ -39,15 +39,15 @@ To disable Corepack, remove the `DEVBOX_COREPACK_ENABLED` variable from your dev ### Yarn -[**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/nodejs/nodejs-yarn) +[**Example Repo**](https://github.com/jetify-com/devbox?folder=examples/development/nodejs/nodejs-yarn) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/node-yarn) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/nodejs-yarn) ### pnpm -[**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/nodejs/nodejs-pnpm) +[**Example Repo**](https://github.com/jetify-com/devbox?folder=examples/development/nodejs/nodejs-pnpm) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/node-pnpm) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/nodejs-pnpm) ## Installing Global Packages diff --git a/docs/app/docs/devbox_examples/languages/php.md b/docs/app/docs/devbox_examples/languages/php.md index 8d30573a753..96a7f126bfd 100644 --- a/docs/app/docs/devbox_examples/languages/php.md +++ b/docs/app/docs/devbox_examples/languages/php.md @@ -6,7 +6,7 @@ PHP projects can manage most of their dependencies locally with `composer`. Some [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/php/latest) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/php) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/php) ## Adding PHP to your Project @@ -15,7 +15,7 @@ Run `devbox add php php83Packages.composer`, or add the following to your `devbo ```json "packages": [ "php@latest", - "php83Packages.composer@latest + "php83Packages.composer@latest" ] ``` @@ -46,6 +46,7 @@ The PHP Plugin will provide the following configuration when you install a PHP r ``` ### Services + * php-fpm Use `devbox services start|stop php-fpm` to start PHP-FPM in the background. @@ -79,4 +80,4 @@ You can disable the PHP plugin by running `devbox add php --disable-plugin`, or } } } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/languages/python.md b/docs/app/docs/devbox_examples/languages/python.md index 64f3cee466b..9d32735a719 100644 --- a/docs/app/docs/devbox_examples/languages/python.md +++ b/docs/app/docs/devbox_examples/languages/python.md @@ -10,7 +10,6 @@ Python by default will attempt to install your packages globally, or in the Nix `devbox add python@3.10`, or in your `devbox.json` add: - ```json "packages": [ "python@3.10" @@ -23,7 +22,7 @@ This will install Python 3.10 in your shell. You can find other versions of Pyth [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/python/pip) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/python-pip) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/python-pip) [pip](https://pip.pypa.io/en/stable/) is the standard package manager for Python. Since it installs python packages globally, we strongly recommend using a virtual environment. @@ -48,7 +47,7 @@ For Fish or other shells, you may need to use a different activation script. See ::: -Devbox installs the virtual environment in `.devbox/virtenv/python/.venv` by default. You can modify this path by setting the `VENV_DIR` environment variable in your devbox.json: +Devbox installs the virtual environment in `.devbox/virtenv/python/.venv` by default. You can modify this path by setting the `VENV_DIR` environment variable in your devbox.json: ```json { @@ -83,7 +82,7 @@ If you need to install a specific version of Pip, you can run `devbox add python [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/python/pipenv) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/python-pipenv) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/python-pipenv) [pipenv](https://pipenv.pypa.io/en/latest/) is a tool that will automatically set up a virtual environment for installing your PyPi packages. @@ -100,13 +99,14 @@ You can install `pipenv` by adding it to the packages in your `devbox.json`. You } } ``` + This init_hook will automatically start your virtualenv when you run `devbox shell`. ## Poetry [**Example Link**](https://github.com/jetify-com/devbox/tree/main/examples/development/python/poetry/poetry-demo) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/python-poetry) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/python-poetry) [Poetry](https://python-poetry.org/) is a packaging and dependency manager for Python that helps you manage your Python packages, and can automatically create a virtual environment for your project. @@ -123,6 +123,7 @@ You can install Poetry by adding it to the packages in your `devbox.json`. You c } } ``` + This init_hook will automatically start Poetry's virtualenv when you run `devbox shell`, and provide you with access to all your packages. ## Disabling the Python Plugin @@ -137,4 +138,4 @@ If you would prefer to disable the Python Plugin, you can add python using `devb "disable_plugin": true } } -} \ No newline at end of file +} diff --git a/docs/app/docs/devbox_examples/languages/ruby.md b/docs/app/docs/devbox_examples/languages/ruby.md index 746f9243db3..93f79e934c4 100644 --- a/docs/app/docs/devbox_examples/languages/ruby.md +++ b/docs/app/docs/devbox_examples/languages/ruby.md @@ -4,7 +4,7 @@ title: Ruby [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/ruby) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/ruby) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/ruby) Ruby can be automatically configured by Devbox via the built-in Ruby Plugin. This plugin will activate automatically when you install Ruby 2.7 using `devbox add ruby`. @@ -62,4 +62,4 @@ In case you are using bundler to install gems, bundler config file can still be ```dotenv BUNDLE_BUILD__SASSC: "--disable-lto" -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/languages/rust.md b/docs/app/docs/devbox_examples/languages/rust.md index 31945170c6e..d13c33eacaa 100644 --- a/docs/app/docs/devbox_examples/languages/rust.md +++ b/docs/app/docs/devbox_examples/languages/rust.md @@ -6,7 +6,7 @@ The easiest way to manage Rust with Devbox is to install `rustup`, and then conf [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/rust) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/rust) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/rust) ```json { diff --git a/docs/app/docs/devbox_examples/languages/zig.md b/docs/app/docs/devbox_examples/languages/zig.md index ef4ad9c73f2..19c4efb3404 100644 --- a/docs/app/docs/devbox_examples/languages/zig.md +++ b/docs/app/docs/devbox_examples/languages/zig.md @@ -6,7 +6,7 @@ Zig projects can be run in Devbox by adding Zig and Nimble to your project. [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/zig/zig-hello-world) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/zig) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/zig) ## Adding Zig to your Project diff --git a/docs/app/docs/devbox_examples/servers/apache.md b/docs/app/docs/devbox_examples/servers/apache.md index f55c79f2191..880c948e695 100644 --- a/docs/app/docs/devbox_examples/servers/apache.md +++ b/docs/app/docs/devbox_examples/servers/apache.md @@ -6,7 +6,7 @@ Apache can be automatically configured by Devbox via the built-in Apache Plugin. [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/servers/apache) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/apache) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/apache) ### Adding Apache to your Shell @@ -25,11 +25,13 @@ This will install the latest version of Apache. You can find other installable v The Apache plugin will automatically create the following configuration when you install Apache with `devbox add`. ### Services + * apache Use `devbox services start|stop apache` to start and stop httpd in the background. ### Helper Files + The following helper files will be created in your project directory: * \{PROJECT_DIR\}/devbox.d/apacheHttpd/httpd.conf @@ -38,6 +40,7 @@ The following helper files will be created in your project directory: Note that by default, Apache is configured with `./devbox.d/web` as the DocumentRoot. To change this, you should copy and modify the default `./devbox.d/apacheHttpd/httpd.conf`. ### Environment Variables + ```bash HTTPD_ACCESS_LOG_FILE={PROJECT_DIR}/.devbox/virtenv/apacheHttpd/access.log HTTPD_ERROR_LOG_FILE={PROJECT_DIR}/.devbox/virtenv/apacheHttpd/error.log @@ -63,4 +66,4 @@ You can disable the Apache plugin by running `devbox add apache --disable-plugin } } } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/servers/caddy.md b/docs/app/docs/devbox_examples/servers/caddy.md index e0a084f9dd2..fcdac11ec9f 100644 --- a/docs/app/docs/devbox_examples/servers/caddy.md +++ b/docs/app/docs/devbox_examples/servers/caddy.md @@ -6,7 +6,7 @@ Caddy can be configured automatically using Devbox's built in Caddy plugin. This [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/servers/caddy) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/caddy) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/caddy) ### Adding Caddy to your Shell @@ -25,11 +25,13 @@ This will install the latest version of Caddy. You can find other installable ve The Caddy plugin will automatically create the following configuration when you install Caddy with `devbox add` ### Services + * caddy Use `devbox services start|stop caddy` to start and stop httpd in the background ### Helper Files + The following helper files will be created in your project directory: * \{PROJECT_DIR\}/devbox.d/caddy/Caddyfile @@ -38,6 +40,7 @@ The following helper files will be created in your project directory: Note that by default, Caddy is configured with `./devbox.d/web` as the root. To change this, you should modify the default `./devbox.d/caddy/Caddyfile` or change the `CADDY_ROOT_DIR` environment variable ### Environment Variables + ```bash * CADDY_CONFIG={PROJECT_DIR}/devbox.d/caddy/Caddyfile * CADDY_LOG_DIR={PROJECT_DIR}/.devbox/virtenv/caddy/log @@ -61,4 +64,4 @@ You can disable the Caddy plugin by running `devbox add caddy --disable-plugin`, } }, } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/servers/nginx.md b/docs/app/docs/devbox_examples/servers/nginx.md index 28d5e36a3eb..ac88d70ccbf 100644 --- a/docs/app/docs/devbox_examples/servers/nginx.md +++ b/docs/app/docs/devbox_examples/servers/nginx.md @@ -6,7 +6,7 @@ NGINX can be automatically configured by Devbox via the built-in NGINX Plugin. T [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/servers/nginx) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/nginx) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/nginx) ## Adding NGINX to your Shell @@ -23,11 +23,13 @@ This will install the latest version of NGINX. You can find other installable ve ## NGINX Plugin Details ### Services + * nginx Use `devbox services start|stop nginx` to start and stop the NGINX service in the background ### Helper Files + The following helper files will be created in your project directory: * devbox.d/nginx/nginx.conf @@ -35,11 +37,12 @@ The following helper files will be created in your project directory: * devbox.d/nginx/fastcgi.conf * devbox.d/web/index.html -Devbox uses [envsubst](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html) to generate `nginx.conf` from the `nginx.template` file every time Devbox starts a shell, service, or script. This allows you to create an NGINX config using environment variables by modifying `nginx.template`. To edit your NGINX configuration, you should modify the `nginx.template` file. +Devbox uses [envsubst](https://www.gnu.org/software/gettext/manual/html_node/envsubst-Invocation.html) to generate `nginx.conf` from the `nginx.template` file every time Devbox starts a shell, service, or script. This allows you to create an NGINX config using environment variables by modifying `nginx.template`. To edit your NGINX configuration, you should modify the `nginx.template` file. Note that by default, NGINX is configured with `./devbox.d/web` as the root directory. To change this, you should modify `./devbox.d/nginx/nginx.template` ### Environment Variables + ```bash NGINX_CONFDIR=devbox.d/nginx/nginx.conf NGINX_PATH_PREFIX=.devbox/virtenv/nginx @@ -47,9 +50,11 @@ NGINX_TMPDIR=.devbox/virtenv/nginx/temp ``` ### Notes + You can easily configure NGINX by modifying these env variables in your shell's `init_hook` To customize: + * Use $NGINX_CONFDIR to change the configuration directory * Use $NGINX_LOGDIR to change the log directory * Use $NGINX_PIDDIR to change the pid directory @@ -73,4 +78,4 @@ You can disable the NGINX plugin by running `devbox add nginx --disable-plugin`, } } } -``` \ No newline at end of file +``` diff --git a/docs/app/docs/devbox_examples/stacks/django.md b/docs/app/docs/devbox_examples/stacks/django.md index 72ab1311aab..ad239f4853e 100644 --- a/docs/app/docs/devbox_examples/stacks/django.md +++ b/docs/app/docs/devbox_examples/stacks/django.md @@ -1,10 +1,10 @@ -# Django +# Django This example demonstrates how to configure and run a Django app using Devbox. It installs Python, PostgreSQL, and uses `pip` to install your Python dependencies in a virtual environment. [Example Repo](https://github.com/jetify-com/devbox/tree/main/examples/stacks/django) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/django) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/django) ## How to Use @@ -31,7 +31,6 @@ This example demonstrates how to configure and run a Django app using Devbox. It You can also add these lines to your `init_hook` to automatically activate your venv whenever you start your shell - ### Setting up the Database The Django example uses a Postgres database. To set up the database, we will first create a new PostgreSQL database cluster, create the `todo_db` and user, and run the Django migrations. @@ -66,4 +65,4 @@ You can now start your Django server by running the following command. python todo_project/manage.py runserver ``` -This should start the development server. +This should start the development server. diff --git a/docs/app/docs/devbox_examples/stacks/drupal.md b/docs/app/docs/devbox_examples/stacks/drupal.md index 0034e069e89..12dea471cfa 100644 --- a/docs/app/docs/devbox_examples/stacks/drupal.md +++ b/docs/app/docs/devbox_examples/stacks/drupal.md @@ -6,9 +6,9 @@ This example shows how to run a Drupal application in Devbox. It makes use of th [Example Repo](https://github.com/jetify-com/devbox/tree/main/examples/stacks/drupal) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/drupal) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/drupal) -## How to Run +## How to Run In this directory, run: @@ -24,7 +24,7 @@ To install Drupal and your dependencies, run `composer install`. The Drupal app To exit the shell, use `exit` -## Installing the Umami Example +## Installing the Umami Example Run the `install-drupal.sh` script to install the Umami Drupal example. This is a good starter project for trying out and familiarizing yourself with Drupal diff --git a/docs/app/docs/devbox_examples/stacks/jekyll.md b/docs/app/docs/devbox_examples/stacks/jekyll.md index 64a3a9602e8..43c8204a68d 100644 --- a/docs/app/docs/devbox_examples/stacks/jekyll.md +++ b/docs/app/docs/devbox_examples/stacks/jekyll.md @@ -2,13 +2,13 @@ title: Jekyll --- -This example demonstrates how to create and run a Jekyll blog in Devbox. It makes use of the Ruby Plugin to configure and setup your project. +This example demonstrates how to create and run a Jekyll blog in Devbox. It makes use of the Ruby Plugin to configure and setup your project. [Example Repo](https://github.com/jetify-com/devbox/tree/main/examples/stacks/jekyll) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/jekyll) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/jekyll) -Inspired by https://litchipi.github.io/nix/2023/01/12/build-jekyll-blog-with-nix.html +Inspired by [](https://litchipi.github.io/nix/2023/01/12/build-jekyll-blog-with-nix.html) ## How to Run @@ -17,7 +17,7 @@ Inspired by https://litchipi.github.io/nix/2023/01/12/build-jekyll-blog-with-nix 3. In the root directory, run `devbox run generate` to install and package the project with bundler 4. In the root directory, run `devbox run server` to start the server. You can access the Jekyll example at `localhost:4000` -## How to Recreate this Example +## How to Recreate this Example 1. Install [Devbox](https://www.jetify.com/devbox/docs/installing_devbox/) 1. In a new directory, run `devbox init` to create an empty config diff --git a/docs/app/docs/devbox_examples/stacks/lapp.md b/docs/app/docs/devbox_examples/stacks/lapp.md index 2b3d35173f3..948818afe16 100644 --- a/docs/app/docs/devbox_examples/stacks/lapp.md +++ b/docs/app/docs/devbox_examples/stacks/lapp.md @@ -6,7 +6,7 @@ This example shows how to build a simple application using Apache, PHP, and Post [Example Repo](https://github.com/jetify-com/devbox/tree/main/examples/stacks/lapp-stack) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/lapp-stack) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/lapp-stack) ## How to Run diff --git a/docs/app/docs/devbox_examples/stacks/laravel.md b/docs/app/docs/devbox_examples/stacks/laravel.md index aaf47f2b3bd..0c61eacd283 100644 --- a/docs/app/docs/devbox_examples/stacks/laravel.md +++ b/docs/app/docs/devbox_examples/stacks/laravel.md @@ -8,7 +8,7 @@ This example shows how to build a simple Laravel application backed by MariaDB a [Example Repo](https://github.com/jetify-com/devbox/tree/main/examples/stacks/laravel) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/github.com/jetify-com/devbox/?folder=examples/stacks/laravel) +[![Open In Devspace](/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/laravel) ## How to Run @@ -28,7 +28,6 @@ This example shows how to build a simple Laravel application backed by MariaDB a 1. For more details on building and developing your Laravel project, visit the [Laravel Docs](https://laravel.com/docs/10.x) - ## How to Recreate this Example ### Creating the Laravel Project diff --git a/docs/app/docs/devbox_examples/stacks/lepp.md b/docs/app/docs/devbox_examples/stacks/lepp.md index ff292b10650..b926f4a99ac 100644 --- a/docs/app/docs/devbox_examples/stacks/lepp.md +++ b/docs/app/docs/devbox_examples/stacks/lepp.md @@ -7,7 +7,7 @@ An example Devbox shell for NGINX, Postgres, and PHP. This example uses Devbox P [Example Repo](https://github.com/jetify-com/devbox/tree/main/examples/stacks/lepp-stack) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/lepp-stack) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/lepp-stack) ## How to Run diff --git a/docs/app/docs/devbox_examples/stacks/rails.md b/docs/app/docs/devbox_examples/stacks/rails.md index 8ce82a96c1c..14d9f4a7fc9 100644 --- a/docs/app/docs/devbox_examples/stacks/rails.md +++ b/docs/app/docs/devbox_examples/stacks/rails.md @@ -7,7 +7,7 @@ This example demonstrates how to setup a simple Rails application. It makes use [Example Repo](https://github.com/jetify-com/devbox/tree/main/examples/stacks/rails) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/rails) +[![Open In Devspace](../../../static/img/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/rails) ## How To Run diff --git a/docs/app/docs/env_variables.md b/docs/app/docs/env_variables.md index ed12516e67f..8119ac6075d 100644 --- a/docs/app/docs/env_variables.md +++ b/docs/app/docs/env_variables.md @@ -4,7 +4,7 @@ title: Devbox Env Variables The following is a list of Environment variables used by Devbox to manage your environment. Some of these variables are set by Devbox, while others can be used to manage how Devbox sets up your shell. -Note that this list only describes variables that are set by Devbox itself. [Devbox plugins](/guides/plugins) may set their own environment variables, which are documented in their respective pages and via `devbox info `. +Note that this list only describes variables that are set by Devbox itself. [Devbox plugins](/devbox/docs/guides/plugins) may set their own environment variables, which are documented in their respective pages and via `devbox info `. ## Environment Variables Set by Devbox Shell diff --git a/docs/app/docs/faq.md b/docs/app/docs/faq.md index c003a01c505..dd9dfb919f2 100644 --- a/docs/app/docs/faq.md +++ b/docs/app/docs/faq.md @@ -49,7 +49,7 @@ devbox add github:NixOS/nixpkgs#prometheus^out,cli Packages may take a long time to install if they do not have a binary available in the public Nix Cache. If a prebuilt binary is not available, Nix will built the package from source. -If prebuilt binaries are not available in the public cache, you may want to use the [Jetify Cache](./cloud/cache/index.md) or the [Jetify Prebuilt Cache](./cloud/cache/prebuilt_cache.md) to cache the binaries you build for future use. Using a package cache can reduce package install by up to 90% compared to building from source. +If prebuilt binaries are not available in the public cache, you may want to use the [Jetify Cache](/cloud/docs/cache/) or the [Jetify Prebuilt Cache](/cloud/docs/cache/prebuilt_cache) to cache the binaries you build for future use. Using a package cache can reduce package install by up to 90% compared to building from source. ## I'm trying to build a project, but it says that I'm missing `libstdc++`. How do I install this library in my project? @@ -66,7 +66,7 @@ There are three ways to work around this issue: ## How can I use custom Nix packages or overrides with Devbox? -You can add customized packages to your Devbox environment using our [Flake support](./guides/using_flakes.md). You can use these flakes to modify or override packages from nixpkgs, or to create your own custom packages. +You can add customized packages to your Devbox environment using our [Flake support](/devbox/docs/guides/using_flakes). You can use these flakes to modify or override packages from nixpkgs, or to create your own custom packages. ## Can I use Devbox if I use [Fish](https://fishshell.com/)? diff --git a/docs/app/docs/guides/secrets.md b/docs/app/docs/guides/secrets.md new file mode 100644 index 00000000000..8e2b3b187cc --- /dev/null +++ b/docs/app/docs/guides/secrets.md @@ -0,0 +1,43 @@ +--- +title: Managing Secrets and Environment Variables +--- + +Devbox provides a few different methods for including environment variables and secrets in your Devbox shell. This guide will walk you through the different methods and help you choose the best one for your use case. + +## Setting Environment Variables in your Devbox Config + +Environment variables that do not need to be stored securely can be set directly in your `devbox.json` under the `env` object. This is useful for non-secret variables that you want to have set in your Devbox shells: + +```json +{ + "env": { + "MY_VAR": "my_value" + }, + "packages": {}, + "shell": {} +} +``` + +Currently, you can only set values using string literals, `$PWD`, and `$PATH`. Any other values with environment variables will not be expanded when starting your shell. For more details, see (/devbox/docs/configuration.md). + +## Setting Environment Variables with Env Files + +For environment variables that you want to keep out of your `devbox.json` file, you can use an env file. Env files are text files that contain key-value pairs, one per line. You can reference an env file in your `devbox.json` like this: + +```json +{ + "packages": {}, + "shell": {}, + "env_from": [ + "path/to/.env" + ] +} +``` + +## Securely Managing Secrets with Jetify Secrets + +For secrets that need to be stored securely, you can use Jetify Secrets. Jetify Secrets is a secure secrets management service that allows you to store and manage your secrets with Jetify. You can then access your secrets whenever you start your Devbox shell, and manage them from the CLI using [`devbox secrets`](/devbox/docs/cli_reference/devbox_secrets). + +To get started with Jetify Secrets, you will need to first create an account on Jetify Cloud and login with `devbox auth login`. Once your account is created, you can create a new project and start adding secrets to your project using `devbox secrets init`. + +For more details on how to manage your secrets from the CLI, see our guide on [**Jetify Secrets**](/cloud/docs/secrets/secrets_cli). diff --git a/docs/app/docs/guides/using_flakes.md b/docs/app/docs/guides/using_flakes.md index c8abcfac0f4..3637770146d 100644 --- a/docs/app/docs/guides/using_flakes.md +++ b/docs/app/docs/guides/using_flakes.md @@ -93,9 +93,9 @@ path:./my-flake#my-package ## Caching Flakes with the Jetify Cache -Because flakes are not automatically built and cached by Nix, you may experience slower build times when using flakes in your Devbox project. To speed up your builds, you can use the [Jetify Cache](../cloud/cache/index.md) to cache the binaries built by your flakes for future use. +Because flakes are not automatically built and cached by Nix, you may experience slower build times when using flakes in your Devbox project. To speed up your builds, you can use the [Jetify Cache](/cloud/docs/cache/) to cache the binaries built by your flakes for future use. -After setting up your cache directly, you can upload the flake by running: +After setting up your cache directly, you can upload the flake by running: ```bash devbox cache upload diff --git a/docs/app/docs/nixhub/sidebar.ts b/docs/app/docs/nixhub/sidebar.ts index 348081a31da..4087feb20fa 100644 --- a/docs/app/docs/nixhub/sidebar.ts +++ b/docs/app/docs/nixhub/sidebar.ts @@ -1,24 +1,23 @@ import type { SidebarsConfig } from "@docusaurus/plugin-content-docs"; const nixhubSidebar: SidebarsConfig = { - sidebar: - [ - { - type: "doc", - label: "Get a Package", - id: "nixhub/get-a-package", - }, - { - type: "doc", - label: "Search Packages", - id: "nixhub/search-packages", - }, - { - type: "doc", - label: "Resolve a Package", - id: "nixhub/resolve-a-package-version", - } - ] -} + sidebar: [ + { + type: "doc", + label: "Get a Package", + id: "nixhub/get-a-package", + }, + { + type: "doc", + label: "Search Packages", + id: "nixhub/search-packages", + }, + { + type: "doc", + label: "Resolve a Package", + id: "nixhub/resolve-a-package-version", + }, + ], +}; -export default nixhubSidebar.sidebar; \ No newline at end of file +export default nixhubSidebar.sidebar; diff --git a/docs/app/docs/quickstart.mdx b/docs/app/docs/quickstart.mdx index 34eb96dd72e..2f3465537b6 100644 --- a/docs/app/docs/quickstart.mdx +++ b/docs/app/docs/quickstart.mdx @@ -21,7 +21,7 @@ Follow the instruction from [the installation guide](./installing_devbox.mdx). :::note If you want to try Devbox before installing it, you can open a cloud shell on your browser using the link below -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/tutorial) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://www.jetify.com/devbox/templates/tutorial) ::: ## Create a Development Environment @@ -174,10 +174,10 @@ Once you publish your Devbox project to Github, you can help other developers ge ### Boost your dev environment with Jetify Cloud -* **[Jetify Secrets](./cloud/secrets/index.md):** Securely store and access your secrets and environment variables in your Devbox projects. -* **[Jetify Deploys](./cloud/deploys/index.md):** Deploy your Devbox projects as autoscaling services with a single command. -* **[Jetify Cache](./cloud/cache/index.md):** Share and cache packages across all your Devbox projects and environments. -* **[Jetify Prebuilt Cache](./cloud/cache/prebuilt_cache.md):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. +* **[Jetify Secrets](/cloud/docs/secrets/):** Securely store and access your secrets and environment variables in your Devbox projects. +* **[Jetify Deploys](/cloud/docs/deploys/):** Deploy your Devbox projects as autoscaling services with a single command. +* **[Jetify Cache](/cloud/docs/cache/):** Share and cache packages across all your Devbox projects and environments. +* **[Jetify Prebuilt Cache](/cloud/docs/cache/prebuilt_cache):** Use the Jetify Public Cache to speed up your Devbox builds and share packages with the community. ### Get Involved * **[Join our Discord Community](https://discord.gg/jetify):** Chat with the development team and our growing community of Devbox users. diff --git a/docs/app/docusaurus.config.js b/docs/app/docusaurus.config.js index 7981f620f39..3340e6b5434 100644 --- a/docs/app/docusaurus.config.js +++ b/docs/app/docusaurus.config.js @@ -1,185 +1,197 @@ // @ts-check // Note: type annotations allow type checking and IDEs autocompletion -import { themes } from 'prism-react-renderer'; +import { themes } from "prism-react-renderer"; const codeTheme = { light: themes.github, dark: themes.dracula }; /** @type {import('@docusaurus/types').Config} */ const config = { - title: 'Devbox', - tagline: 'Instant, easy, and predictable shells and containers', - url: 'https://www.jetify.com', - baseUrl: '/devbox/docs/', - onBrokenLinks: 'throw', - onBrokenMarkdownLinks: 'warn', - favicon: 'img/favicon.ico', - trailingSlash: true, + title: "Jetify Docs", + tagline: "Instant, easy, and predictable shells and containers", + url: "https://www.jetify.com", + baseUrl: "/", + onBrokenLinks: "throw", + onBrokenMarkdownLinks: "warn", + favicon: "img/favicon.ico", + trailingSlash: true, - // GitHub pages deployment config. - // If you aren't using GitHub pages, you don't need these. - organizationName: 'jetify-com', // Usually your GitHub org/user name. - projectName: 'devbox', // Usually your repo name. + // GitHub pages deployment config. + // If you aren't using GitHub pages, you don't need these. + organizationName: "jetify-com", // Usually your GitHub org/user name. + projectName: "devbox", // Usually your repo name. - // Even if you don't use internalization, you can use this field to set useful - // metadata like html lang. For example, if your site is Chinese, you may want - // to replace "en" with "zh-Hans". - markdown: { - mermaid: true, - }, - themes: [ - 'docusaurus-theme-openapi-docs', - '@docusaurus/theme-mermaid' - ], - i18n: { - defaultLocale: 'en', - locales: ['en'], - }, - presets: [ - [ - 'classic', - /** @type {import('@docusaurus/preset-classic').Options} */ - ({ - docs: { - routeBasePath: '/', - sidebarPath: require.resolve('./sidebars.js'), - // Please change this to your repo. - // Remove this to remove the "edit this page" links. - docItemComponent: "@theme/ApiItem", - editUrl: "https://github.com/jetify-com/devbox/tree/main/docs/app/" - }, - blog: false, - theme: { - customCss: require.resolve('./src/css/custom.css'), - }, + // Even if you don't use internalization, you can use this field to set useful + // metadata like html lang. For example, if your site is Chinese, you may want + // to replace "en" with "zh-Hans". + markdown: { + mermaid: true, + }, + themes: ["docusaurus-theme-openapi-docs", "@docusaurus/theme-mermaid"], + i18n: { + defaultLocale: "en", + locales: ["en"], + }, + presets: [ + [ + "classic", + /** @type {import('@docusaurus/preset-classic').Options} */ + ({ + docs: { + routeBasePath: "/devbox/docs", + sidebarPath: require.resolve("./sidebars.js"), + // Please change this to your repo. + // Remove this to remove the "edit this page" links. + docItemComponent: "@theme/ApiItem", + editUrl: "https://github.com/jetify-com/devbox/tree/main/docs/app/", + }, + blog: false, + theme: { + customCss: require.resolve("./src/css/custom.css"), + }, - gtag: { - trackingID: 'G-PL4J94CXFK', - anonymizeIP: true, - }, - } ), - ], + gtag: { + trackingID: "G-PL4J94CXFK", + anonymizeIP: true, + }, + }), ], + ], - plugins: [ - [ - 'docusaurus-plugin-openapi-docs', - { - id: 'api', - docsPluginId: 'classic', - config: { - nixhub: { - specPath: "specs/nixhub.yaml", - outputDir: "docs/nixhub", - - } - } - } - ] + plugins: [ + [ + "@docusaurus/plugin-content-docs", + { + id: "cloud", + path: "cloud", + routeBasePath: "/cloud/docs", + sidebarPath: require.resolve("./cloud_sidebars.js"), + }, ], + [ + "docusaurus-plugin-openapi-docs", + { + id: "api", + docsPluginId: "classic", + config: { + nixhub: { + specPath: "specs/nixhub.yaml", + outputDir: "docs/nixhub", + }, + }, + }, + ], + ], - themeConfig: + themeConfig: /** @type {import('@docusaurus/preset-classic').ThemeConfig} */ - ({ - navbar: { - - logo: { - alt: 'Devbox', - src: 'img/devbox_logo_light.svg', - srcDark: 'img/devbox_logo_dark.svg' - }, + ({ + navbar: { + logo: { + alt: "Devbox", + src: "img/devbox_logo_light.svg", + srcDark: "img/devbox_logo_dark.svg", + href: "/devbox/docs", + }, + items: [ + { + to: "cloud/docs", + label: "Jetify Cloud", + className: "header-text-link", + position: "left", + }, + { + to: "/devbox/docs/nixhub", + label: "NixHub API", + className: "header-text-link", + position: "left", + }, + { + href: "https://discord.gg/jetify", + // label: 'Discord', + className: "header-discord-link", + position: "right", + }, + { + href: "https://github.com/jetify-com/devbox", + // label: 'GitHub', + className: "header-github-link", + position: "right", + }, + ], + }, + footer: { + links: [ + { + title: "Jetify", items: [ - { - to: 'https://cloud.jetify.com', - label: 'Jetify Cloud', - className: 'header-text-link', - position: 'left', - }, - { - href: 'https://discord.gg/jetify', - // label: 'Discord', - className: 'header-discord-link', - position: 'right', - }, - { - href: 'https://github.com/jetify-com/devbox', - // label: 'GitHub', - className: 'header-github-link', - position: 'right', - }, + { + label: "Jetify", + href: "https://www.jetify.com", + }, + { + label: "Blog", + href: "https://www.jetify.com/blog", + }, + { + label: "Jetify Cloud", + href: "https://cloud.jetify.com", + }, ], - }, - footer: { - links: [{ - title: "Jetify", - items: [{ - label: "Jetify", - href: "https://www.jetify.com" - }, - { - label: "Blog", - href: "https://www.jetify.com/blog" - }, - { - label: "Jetify Cloud", - href: "https://cloud.jetify.com" - } - ] - }, - { - title: "Devbox", - items: [{ - label: "Home", - to: "https://www.jetify.com/devbox" - }, - { - label: "Docs", - to: "https://www.jetify.com/devbox/docs/" - } - ] - }, - - { - title: "Community", - items: [ - - { - label: "Github", - href: "https://github.com/jetify-com" - }, - { - label: "Twitter", - href: "https://twitter.com/jetify_com" - }, - { - href: 'https://discord.gg/jetify', - label: 'Discord', - }, - { - href: "https://www.youtube.com/channel/UC7FwfJZbunZR2s-jG79vuTQ", - label: "Youtube" - } - ] - } + }, + { + title: "Devbox", + items: [ + { + label: "Home", + to: "https://www.jetify.com/devbox", + }, + { + label: "Docs", + to: "https://www.jetify.com/devbox/docs/", + }, ], - style: 'dark', - copyright: `Copyright © ${new Date().getFullYear()} Jetify, Inc.`, - }, - colorMode: { - respectPrefersColorScheme: true - }, - algolia: { - appId: 'J1RTMNIB0R', - apiKey: 'b1bcbf465b384ccd6d986e85d6a62c28', - indexName: 'jetpack', - searchParameters: {}, + }, - }, - prism: { - theme: codeTheme.light, - darkTheme: codeTheme.dark, - additionalLanguages: ['bash', 'json'], - }, + { + title: "Community", + items: [ + { + label: "Github", + href: "https://github.com/jetify-com", + }, + { + label: "Twitter", + href: "https://twitter.com/jetify_com", + }, + { + href: "https://discord.gg/jetify", + label: "Discord", + }, + { + href: "https://www.youtube.com/channel/UC7FwfJZbunZR2s-jG79vuTQ", + label: "Youtube", + }, + ], + }, + ], + style: "dark", + copyright: `Copyright © ${new Date().getFullYear()} Jetify, Inc.`, + }, + colorMode: { + respectPrefersColorScheme: true, + }, + algolia: { + appId: "J1RTMNIB0R", + apiKey: "b1bcbf465b384ccd6d986e85d6a62c28", + indexName: "jetpack", + searchParameters: {}, + }, + prism: { + theme: codeTheme.light, + darkTheme: codeTheme.dark, + additionalLanguages: ["bash", "json"], + }, }), }; diff --git a/docs/app/sidebars.js b/docs/app/sidebars.js index b135a4c1752..00f31bb121c 100644 --- a/docs/app/sidebars.js +++ b/docs/app/sidebars.js @@ -39,10 +39,6 @@ const sidebars = { type: "doc", id: "devbox_global", }, - { - type: "doc", - id: "devbox_cloud/index", - }, ], }, { @@ -80,63 +76,6 @@ const sidebars = { }, ], }, - { - type: "category", - label: "Using Devbox with Jetify Cloud", - link: { type: "doc", id: "cloud/index" }, - collapsed: true, - items: [ - { - type: "doc", - label: "Introduction to Jetify Cloud", - id: "cloud/index", - }, - { - type: "category", - label: "Managing your Team", - items: [ - { - type: "autogenerated", - dirName: "cloud/dashboard", - }, - ], - }, - { - type: "category", - label: "Caching your Project Packages with Jetify Cache", - items: [ - { - type: "autogenerated", - dirName: "cloud/cache", - }, - ], - }, - { - type: "category", - label: "Syncing and Managing Secrets with Jetify Secrets", - items: [ - { - type: "autogenerated", - dirName: "cloud/secrets", - }, - ], - }, - { - type: "category", - label: "Deploying your Project with Jetify Deployments", - items: [ - { - type: "autogenerated", - dirName: "cloud/deploys", - }, - ], - }, - { - type: "doc", - id: "cloud/faq", - }, - ], - }, { type: "category", label: "Reference", @@ -196,63 +135,62 @@ const sidebars = { }, ], }, + ], + }, + { + type: "category", + label: "Examples", + link: { type: "doc", id: "devbox_examples/index" }, + items: [ { type: "category", - label: "Examples", - link: { type: "doc", id: "devbox_examples/index" }, + label: "Languages", + collapsed: true, items: [ { - type: "category", - label: "Languages", - collapsed: true, - items: [ - { - type: "autogenerated", - dirName: "devbox_examples/languages", - }, - ], - }, - { - type: "category", - label: "Databases", - collapsed: true, - items: [ - { - type: "autogenerated", - dirName: "devbox_examples/databases", - }, - ], + type: "autogenerated", + dirName: "devbox_examples/languages", }, + ], + }, + { + type: "category", + label: "Databases", + collapsed: true, + items: [ { - type: "category", - label: "Servers", - collapsed: true, - items: [ - { - type: "autogenerated", - dirName: "devbox_examples/servers", - }, - ], + type: "autogenerated", + dirName: "devbox_examples/databases", }, + ], + }, + { + type: "category", + label: "Servers", + collapsed: true, + items: [ { - type: "category", - label: "Stacks", - collapsed: true, - items: [ - { - type: "autogenerated", - dirName: "devbox_examples/stacks", - }, - ], + type: "autogenerated", + dirName: "devbox_examples/servers", }, ], }, { - type: "doc", - id: "faq", + type: "category", + label: "Stacks", + collapsed: true, + items: [ + { + type: "autogenerated", + dirName: "devbox_examples/stacks", + }, + ], }, ], }, + {type: "doc", + id: "faq", + }, ], apiSidebar: [ @@ -260,6 +198,7 @@ const sidebars = { type: "category", label: "Nixhub API Reference", collapsed: false, + collapsible: false, link: { type: "doc", id: "nixhub/index", diff --git a/docs/app/static/img/dashboard_create_new_devspace.png b/docs/app/static/img/dashboard_create_new_devspace.png new file mode 100644 index 00000000000..62529c32205 Binary files /dev/null and b/docs/app/static/img/dashboard_create_new_devspace.png differ diff --git a/docs/app/static/img/open-in-devspace.svg b/docs/app/static/img/open-in-devspace.svg new file mode 100644 index 00000000000..40acc98428f --- /dev/null +++ b/docs/app/static/img/open-in-devspace.svg @@ -0,0 +1,19 @@ + + + + + + + + + + + + + + + + + + + diff --git a/docs/app/tsconfig.json b/docs/app/tsconfig.json index 6f4756980d4..049da3879b1 100644 --- a/docs/app/tsconfig.json +++ b/docs/app/tsconfig.json @@ -1,7 +1,8 @@ { // This file is not used in compilation. It is here just for a nice editor experience. "extends": "@tsconfig/docusaurus/tsconfig.json", + "exclude": ["node_modules", "build", ".docusaurus", ".devbox"], "compilerOptions": { - "baseUrl": "." + "baseUrl": ".", } } diff --git a/examples/cloud_development/maelstrom/README.md b/examples/cloud_development/maelstrom/README.md index 4bf8871feec..619f5346043 100644 --- a/examples/cloud_development/maelstrom/README.md +++ b/examples/cloud_development/maelstrom/README.md @@ -1,6 +1,6 @@ # Maelstrom -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/github.com/jetify-com/devbox-examples?folder=cloud_development/maelstrom) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/maelstrom) A Devbox for running [Maelstrom](https://github.com/jepsen-io/maelstrom) Tests. Maelstrom is a testing library for toy distributed systems built by @aphyr, useful for learning the basics and principals of building distributed systems @@ -14,7 +14,7 @@ If you don't already have [Devbox](https://www.jetify.com/devbox/docs/installing curl -s https://get.jetify.com/install.sh | bash ``` -You can skip this step if you're running on Devbox.sh +You can skip this step if you're running on devbox.sh ## Usage diff --git a/examples/development/bun/README.md b/examples/development/bun/README.md index ca40f1e1b65..e7948820f70 100644 --- a/examples/development/bun/README.md +++ b/examples/development/bun/README.md @@ -4,7 +4,7 @@ Bun projects can be run in Devbox by adding the Bun runtime + package manager to [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/bun) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/bun) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/bun) ## Add Bun to your Project @@ -12,13 +12,13 @@ Bun projects can be run in Devbox by adding the Bun runtime + package manager to devbox add bun@latest ``` -You can see which versions of `bun` are available using: +You can see which versions of `bun` are available using: ```bash devbox search bun ``` -To update bun to the latest version: +To update bun to the latest version: ```bash devbox update bun diff --git a/examples/development/csharp/hello-world/README.md b/examples/development/csharp/hello-world/README.md index 99cd6eeabf3..e699da75628 100644 --- a/examples/development/csharp/hello-world/README.md +++ b/examples/development/csharp/hello-world/README.md @@ -4,7 +4,7 @@ C# and .NET projects can be easily generated in Devbox by adding the dotnet SDK [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/csharp) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/dotnet) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/dotnet) ## Adding .NET to your project diff --git a/examples/development/elixir/elixir_hello/README.md b/examples/development/elixir/elixir_hello/README.md index 59afa9a99d8..2105c97f650 100644 --- a/examples/development/elixir/elixir_hello/README.md +++ b/examples/development/elixir/elixir_hello/README.md @@ -2,6 +2,8 @@ Basic Elixir project using Mix in Devbox. +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/elixir) + ## Configuration This project configures Hex and Mix to install packages + dependencies in local project directories. You can modify where these packages are installed by changing the variables in `conf/set-env.sh` diff --git a/examples/development/fsharp/hello-world/README.md b/examples/development/fsharp/hello-world/README.md index 81080b9f7b8..8837f5d36fd 100644 --- a/examples/development/fsharp/hello-world/README.md +++ b/examples/development/fsharp/hello-world/README.md @@ -4,7 +4,7 @@ F# and .NET projects can be easily generated in Devbox by adding the dotnet SDK [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/fsharp) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/fsharp) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/fsharp) ## Adding .NET to your project diff --git a/examples/development/go/hello-world/README.md b/examples/development/go/hello-world/README.md index 85dfe8b2e9d..cd6b40c4d76 100644 --- a/examples/development/go/hello-world/README.md +++ b/examples/development/go/hello-world/README.md @@ -4,7 +4,7 @@ Go projects can be run in Devbox by adding the Go SDK to your project. If your p [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/go/hello-world) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/go) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/go) ## Adding Go to your Project diff --git a/examples/development/java/gradle/hello-world/README.md b/examples/development/java/gradle/hello-world/README.md index f70ddea7278..3fe237003cd 100644 --- a/examples/development/java/gradle/hello-world/README.md +++ b/examples/development/java/gradle/hello-world/README.md @@ -26,7 +26,7 @@ Other distributions of the JDK (such as OracleJDK and Eclipse Temurin) are avail [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/java/gradle/hello-world) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/java-gradle) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/java-gradle) Gradle is a popular, multi-language build tool that is commonly used with JVM projects. To setup an example project using Gradle, follow the instructions below: diff --git a/examples/development/java/maven/hello-world/README.md b/examples/development/java/maven/hello-world/README.md index 30ad80c6b52..9e206d24dfd 100644 --- a/examples/development/java/maven/hello-world/README.md +++ b/examples/development/java/maven/hello-world/README.md @@ -26,7 +26,7 @@ Other distributions of the JDK (such as OracleJDK and Eclipse Temurin) are avail [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/java/maven/hello-world) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/java-maven) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/java-maven) Maven is an all-in-one CI-CD tool for building testing and deploying Java projects. To setup a sample project with Java and Maven in devbox follow the steps below: diff --git a/examples/development/nodejs/nodejs-npm/README.md b/examples/development/nodejs/nodejs-npm/README.md index d13c8707d32..e65c332d185 100644 --- a/examples/development/nodejs/nodejs-npm/README.md +++ b/examples/development/nodejs/nodejs-npm/README.md @@ -4,7 +4,7 @@ Most NodeJS Projects will install their dependencies locally using NPM or Yarn, [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/nodejs) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/node-npm) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/new/templates/node-npm) ## Adding NodeJS to your Shell diff --git a/examples/development/nodejs/nodejs-pnpm/README.md b/examples/development/nodejs/nodejs-pnpm/README.md index f2f95c7ab61..c36f17671f9 100644 --- a/examples/development/nodejs/nodejs-pnpm/README.md +++ b/examples/development/nodejs/nodejs-pnpm/README.md @@ -2,7 +2,7 @@ Most NodeJS Projects will install their dependencies locally using NPM or Yarn, and thus can work with Devbox with minimal additional configuration. Per project packages can be managed via NPM or Yarn. -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/node-npm) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/node-npm) ## Adding NodeJS to your Shell diff --git a/examples/development/nodejs/nodejs-yarn/README.md b/examples/development/nodejs/nodejs-yarn/README.md index be17a681bdf..42cd91abdb6 100644 --- a/examples/development/nodejs/nodejs-yarn/README.md +++ b/examples/development/nodejs/nodejs-yarn/README.md @@ -2,7 +2,7 @@ Most NodeJS Projects will install their dependencies locally using NPM or Yarn, and thus can work with Devbox with minimal additional configuration. Per project packages can be managed via NPM or Yarn. -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/node-npm) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/node-npm) ## Adding NodeJS to your Shell diff --git a/examples/development/php/latest/README.md b/examples/development/php/latest/README.md index cc8a7cf54b4..c0d48255ff7 100644 --- a/examples/development/php/latest/README.md +++ b/examples/development/php/latest/README.md @@ -4,7 +4,7 @@ PHP projects can manage most of their dependencies locally with `composer`. Some [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/php/latest) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/php) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/php) ## Adding PHP to your Project diff --git a/examples/development/python/pip/README.md b/examples/development/python/pip/README.md index cd198340525..d8d00f09393 100644 --- a/examples/development/python/pip/README.md +++ b/examples/development/python/pip/README.md @@ -20,7 +20,7 @@ This will install Python 3.10 in your shell. You can find other versions of Pyth [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/python/pip) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/python-pip) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/python-pip) [pip](https://pip.pypa.io/en/stable/) is the standard package manager for Python. Since it installs python packages globally, we strongly recommend using a virtual environment. diff --git a/examples/development/python/pipenv/README.md b/examples/development/python/pipenv/README.md index b2252778238..4a0047aa56e 100644 --- a/examples/development/python/pipenv/README.md +++ b/examples/development/python/pipenv/README.md @@ -21,7 +21,7 @@ This will install Python 3.10 in your shell. You can find other versions of Pyth [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/python/pipenv) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/python-pipenv) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/python-pipenv) [pipenv](https://pipenv.pypa.io/en/latest/) is a tool that will automatically set up a virtual environment for installing your PyPi packages. diff --git a/examples/development/ruby/README.md b/examples/development/ruby/README.md index 449853cf37f..924db2588df 100644 --- a/examples/development/ruby/README.md +++ b/examples/development/ruby/README.md @@ -2,7 +2,7 @@ [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/development/ruby) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/ruby) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/ruby) Ruby can be automatically configured by Devbox via the built-in Ruby Plugin. This plugin will activate automatically when you install Ruby 2.7 using `devbox add ruby`. diff --git a/examples/servers/apache/README.md b/examples/servers/apache/README.md index 717dd8aab91..3599be41b11 100644 --- a/examples/servers/apache/README.md +++ b/examples/servers/apache/README.md @@ -4,7 +4,7 @@ Apache can be automatically configured by Devbox via the built-in Apache Plugin. [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/servers/apache) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/apache) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/apache) ### Adding Apache to your Shell diff --git a/examples/servers/caddy/README.md b/examples/servers/caddy/README.md index 85df8851fae..abc0596405c 100644 --- a/examples/servers/caddy/README.md +++ b/examples/servers/caddy/README.md @@ -4,7 +4,7 @@ Caddy can be configured automatically using Devbox's built in Caddy plugin. This [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/servers/caddy) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/caddy) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/caddy) ### Adding Caddy to your Shell diff --git a/examples/servers/nginx/README.md b/examples/servers/nginx/README.md index 6d8567fcaff..ccc8c17972e 100644 --- a/examples/servers/nginx/README.md +++ b/examples/servers/nginx/README.md @@ -4,7 +4,7 @@ NGINX can be automatically configured by Devbox via the built-in NGINX Plugin. T [**Example Repo**](https://github.com/jetify-com/devbox/tree/main/examples/servers/nginx) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/nginx) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/nginx) ## Adding NGINX to your Shell diff --git a/examples/stacks/django/README.md b/examples/stacks/django/README.md index f8c3f3c687b..d2303ebf77f 100644 --- a/examples/stacks/django/README.md +++ b/examples/stacks/django/README.md @@ -2,7 +2,7 @@ [![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/django) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/django) ## How to Use diff --git a/examples/stacks/drupal/README.md b/examples/stacks/drupal/README.md index dec85610615..2b4e55f0ceb 100644 --- a/examples/stacks/drupal/README.md +++ b/examples/stacks/drupal/README.md @@ -2,7 +2,7 @@ This example shows how to run a Drupal application in Devbox. It makes use of the PHP and Apache Plugins, while demonstrating how to configure a MariaDB instance to work with Devbox Cloud. -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/drupal) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/drupal) ## How to Run the example diff --git a/examples/stacks/jekyll/README.md b/examples/stacks/jekyll/README.md index 653883d6832..cb381ad9cfe 100644 --- a/examples/stacks/jekyll/README.md +++ b/examples/stacks/jekyll/README.md @@ -2,7 +2,7 @@ [![Built with Devbox](https://www.jetify.com/img/devbox/shield_moon.svg)](https://www.jetify.com/devbox/docs/contributor-quickstart/) -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/jekyll) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/jekyll) Inspired by [This Example](https://litchipi.github.io/nix/2023/01/12/build-jekyll-blog-with-nix.html) diff --git a/examples/stacks/lapp-stack/README.md b/examples/stacks/lapp-stack/README.md index 5fddaf75b77..223b12007d4 100644 --- a/examples/stacks/lapp-stack/README.md +++ b/examples/stacks/lapp-stack/README.md @@ -2,7 +2,7 @@ This example shows how to build a simple application using Apache, PHP, and PostgreSQL. It uses Devbox Plugins for all 3 packages to simplify configuration. -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/lapp-stack) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/lapp-stack) ## How to Run diff --git a/examples/stacks/laravel/README.md b/examples/stacks/laravel/README.md index 874e4af9db8..d6eea92d904 100644 --- a/examples/stacks/laravel/README.md +++ b/examples/stacks/laravel/README.md @@ -4,7 +4,7 @@ Laravel is a powerful web application framework built with PHP. It's a great cho This example shows how to build a simple Laravel application backed by MariaDB and Redis. It uses Devbox Plugins for all 3 Nix packages to simplify configuration -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/github.com/jetify-com/devbox/?folder=examples/stacks/laravel) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/laravel) ## How to Run diff --git a/examples/stacks/lepp-stack/README.md b/examples/stacks/lepp-stack/README.md index 88a46f28e13..b0cc3599d9f 100644 --- a/examples/stacks/lepp-stack/README.md +++ b/examples/stacks/lepp-stack/README.md @@ -2,7 +2,7 @@ An example Devbox shell for NGINX, Postgres, and PHP. This example uses Devbox Plugins for all 3 packages to simplify configuration -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/lepp-stack) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/lepp-stack) ## How to Run diff --git a/examples/stacks/rails/README.md b/examples/stacks/rails/README.md index dbf35cb3d52..a0151ae9c14 100644 --- a/examples/stacks/rails/README.md +++ b/examples/stacks/rails/README.md @@ -2,7 +2,7 @@ This example demonstrates how to setup a simple Rails application. It makes use of the Ruby Plugin, and installs SQLite to use as a database. -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/open/templates/rails) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/rails) ## How To Run diff --git a/examples/tutorial/README.md b/examples/tutorial/README.md index 22b09428e3e..e2c021fbb16 100644 --- a/examples/tutorial/README.md +++ b/examples/tutorial/README.md @@ -2,7 +2,7 @@ This shell includes a basic `devbox.json` with a few useful packages installed, and an example init_hook and script -[![Open In Devbox.sh](https://www.jetify.com/img/devbox/open-in-devbox.svg)](https://devbox.sh/github.com/jetify-com/devbox-examples?folder=tutorial) +[![Open In Devspace](https://www.jetify.com/img/devbox/open-in-devspace.svg)](https://www.jetify.com/devbox/templates/tutorial) ## Adding New Packages