Skip to content

Commit

Permalink
update deployment docs
Browse files Browse the repository at this point in the history
  • Loading branch information
gladwindos committed Apr 9, 2024
1 parent 0d14bdd commit bbea9fd
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions packages/docs/docs/deployment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,15 +4,15 @@ sidebar_position: 5

# Deployment

Deploying the Gateweaver server can be streamlined using Docker. Begin by creating a Dockerfile in the same directory as your `gateweaver.yaml` configuration file. Here's a simple template to get started:
Deploying the Gateweaver server can be streamlined using Docker. Begin by creating a Dockerfile in the same directory as your `gateweaver.yml` configuration file. Here's a simple template to get started:

```Dockerfile title="Dockerfile"
FROM gateweaver/server:<version>
COPY gateweaver.yaml /app/gateweaver.yaml
COPY gateweaver.yml /app/gateweaver.yml
ENV NODE_ENV=production
```

This Dockerfile uses the official Gateweaver server image as the base image and copies your `gateweaver.yaml` configuration file into the container. The `NODE_ENV` environment variable is set to `production` to ensure that Gateweaver runs in production mode.
This Dockerfile uses the official Gateweaver server image as the base image and copies your `gateweaver.yml` configuration file into the container. The `NODE_ENV` environment variable is set to `production` to ensure that Gateweaver runs in production mode.

:::note
Ensure to replace `<version>` with the specific version of Gateweaver you are using. If you have been developing locally using the CLI, it is best to use the same version of `@gateweaver/cli` from your project's `package.json` to maintain compatibility. You can also find the latest version of the Gateweaver server image on the [Docker Hub page](https://hub.docker.com/r/gateweaver/server).
Expand All @@ -22,15 +22,15 @@ Ensure to replace `<version>` with the specific version of Gateweaver you are us

For an even smoother deployment experience, consider using a cloud service like Render or Google Cloud Run. These platforms offer a hassle-free way to deploy your Gateweaver server by leveraging the power of containers. Here’s a general approach to follow:

1. **Prepare Your Repository:** Ensure your project, including the `Dockerfile` and `gateweaver.yaml`, is pushed to your source code repository.
1. **Prepare Your Repository:** Ensure your project, including the `Dockerfile` and `gateweaver.yml`, is pushed to your source code repository.

2. **Choose a Deployment Service:** Services like Render and Google Cloud Run simplify the deployment process by building containers directly from your repository.

3. **Configure the Service:** While each service has its own setup process, you'll typically need to:

- Point the service to your repository.
- Specify the location of your `Dockerfile`.
- Configure any necessary environment variables or settings specific to Gateweaver.
- Configure any necessary environment variables.

4. **Deploy:** Follow the service's instructions to deploy your application. These platforms take care of the complexities of container building and deployment, allowing you to focus on development.

Expand Down

0 comments on commit bbea9fd

Please sign in to comment.