Skip to content

Commit 28ccd57

Browse files
authored
docs: update hive self-hosting to use Hive Console instead of GraphQL Hive (#7042)
1 parent 2449790 commit 28ccd57

File tree

1 file changed

+37
-33
lines changed

1 file changed

+37
-33
lines changed

packages/web/docs/src/content/self-hosting/get-started.mdx

Lines changed: 37 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,14 +2,14 @@ import NextImage from 'next/image'
22
import { Callout, Cards, Tabs } from '@theguild/components'
33
import diagram from '../../../public/docs/pages/self-hosting/diagram.png'
44

5-
# Self-Hosting Hive
5+
# Self-Hosting Hive Console
66

7-
If you are not able to use Hive Cloud service, you can self-host it. The self-hosted version is free
8-
and open-source. You can find the full
7+
If you are not able to use the cloud provided Hive Console service, you can self-host it. The
8+
self-hosted version is free and open-source. You can find the full
99
[source code on GitHub](https://github.com/graphql-hive/console).
1010

1111
<Callout>
12-
**Self-hosting Hive** does currently not support all of the features as the Cloud version.
12+
**Self-hosting Hive Console** does currently not support all of the features as the Cloud version.
1313

1414
The following features are currently unavailable when self-hosting:
1515

@@ -18,20 +18,24 @@ The following features are currently unavailable when self-hosting:
1818

1919
</Callout>
2020

21+
If you're interested in hosting one of our gateway solutions, see the documentation for
22+
[Hive Router](https://github.com/graphql-hive/router?tab=readme-ov-file#hive-router-rust) or
23+
[Hive Gateway](https://the-guild.dev/graphql/hive/docs/gateway).
24+
2125
## Pre-Requisites
2226

23-
The easiest way of running GraphQL Hive is using [Docker](https://www.docker.com/) and
27+
The easiest way of running Hive Console is using [Docker](https://www.docker.com/) and
2428
[docker-compose](https://docs.docker.com/compose/).
2529

26-
All the services required for running GraphQL Hive are published to the GitHub container registry
30+
All the services required for running Hive Console are published to the GitHub container registry
2731
([GraphQL Hive Docker Images](https://github.com/orgs/graphql-hive/packages)).
2832

2933
Please make sure to install the Docker daemon as well as `docker-compose` on your machine before
3034
proceeding.
3135

3236
## Self-Hosting Architecture
3337

34-
When self-hosting GraphQL Hive, you are responsible for running and maintaining the following
38+
When self-hosting Hive Console, you are responsible for running and maintaining the following
3539
components:
3640

3741
- [PostgreSQL database](https://www.postgresql.org/)
@@ -56,7 +60,7 @@ ClickHouse) and storage (S3) with managed database/storage (Cloud-based or in-ho
5660

5761
### Architecture Diagram
5862

59-
The following diagram shows the architecture of a self-hosted GraphQL Hive instance:
63+
The following diagram shows the architecture of a self-hosted Hive Console instance:
6064

6165
<NextImage
6266
alt="Self-hosting diagram"
@@ -90,22 +94,22 @@ The following diagram shows the architecture of a self-hosted GraphQL Hive insta
9094
#### Microservices
9195

9296
- **SuperTokens**: an open-source project used for authentication and authorization.
93-
- `webapp`: the main GraphQL Hive web application.
94-
- `server`: the main GraphQL Hive server, responsible for serving the GraphQL API and orchestrating
97+
- `webapp`: the main Hive Console web application.
98+
- `server`: the main Hive Console server, responsible for serving the GraphQL API and orchestrating
9599
calls to other services.
96100
- **CDN**: a custom CDN service, responsible for serving the GraphQL schema artifacts. In
97101
self-hosted architecture, the CDN is provided as part of the `server`.
98-
- `schema`: the GraphQL Hive schema service, responsible for validating, composing and building
102+
- `schema`: the Hive Console schema service, responsible for validating, composing and building
99103
GraphQL schemas.
100-
- `tokens`: the GraphQL Hive tokens service, responsible for generating and validating tokens.
101-
- `usage`: the GraphQL Hive usage service, responsible for receiving usage data from a running
104+
- `tokens`: the Hive Console tokens service, responsible for generating and validating tokens.
105+
- `usage`: the Hive Console usage service, responsible for receiving usage data from a running
102106
GraphQL server, and prepare them for processing.
103-
- `usage-ingestor`: the GraphQL Hive usage-ingestor service, responsible for processing usage data
107+
- `usage-ingestor`: the Hive Console usage-ingestor service, responsible for processing usage data
104108
and storing them in ClickHouse.
105-
- `emails`: the GraphQL Hive emails service, responsible for sending emails.
106-
- `webhooks`: the GraphQL Hive webhooks service, responsible for sending webhooks to external
109+
- `emails`: the Hive Console emails service, responsible for sending emails.
110+
- `webhooks`: the Hive Console webhooks service, responsible for sending webhooks to external
107111
services.
108-
- `policy`: the GraphQL Hive policy service, responsible for validating and enforcing schema
112+
- `policy`: the Hive Console policy service, responsible for validating and enforcing schema
109113
policies.
110114

111115
#### Utility services
@@ -122,15 +126,15 @@ following utility services:
122126

123127
## Quick Start Video
124128

125-
In this video you will learn how to run GraphQL Hive and publish your first schema on your machine
129+
In this video you will learn how to run Hive Console and publish your first schema on your machine
126130
in less than 15 minutes.
127131

128132
<iframe
129133
src="https://www.youtube.com/embed/H57aej4cW2I"
130134
title="GraphQL Hive Self-Hosted Quick Start"
131135
/>
132136

133-
## Running GraphQL Hive
137+
## Running Hive Console
134138

135139
First download the `docker-compose.community.yml` file from the
136140
[GitHub repository](https://github.com/graphql-hive/console/blob/main/docker/docker-compose.community.yml)
@@ -168,7 +172,7 @@ for running Hive locally in a self hosted environment. But before we can spin it
168172
to set some environment variables.
169173

170174
<Callout>
171-
**Docker images** are built and published for each version of GraphQL Hive and tagged accordingly.
175+
**Docker images** are built and published for each version of Hive Console and tagged accordingly.
172176
You can find all the available versions on the [GitHub Releases page prefixed with `hive@`](https://github.com/graphql-hive/console/releases).
173177

174178
We recommend sticking to a specific version to avoid breaking changes. The `latest` version
@@ -213,7 +217,7 @@ docker compose -f docker-compose.community.yml config > docker-compose.with-env.
213217

214218
</Callout>
215219

216-
After setting the environment variables, pull the required images for GraphQL Hive services. This's
220+
After setting the environment variables, pull the required images for Hive Console services. This's
217221
going to take some time if you're doing it for the first time.
218222

219223
```bash
@@ -222,7 +226,7 @@ docker compose -f docker-compose.community.yml pull
222226
docker compose -f docker-compose.with-env.yml pull
223227
```
224228

225-
After it's done, you can start the GraphQL Hive services using `docker compose`.
229+
After it's done, you can start the Hive Console services using `docker compose`.
226230

227231
```bash
228232
docker compose -f docker-compose.community.yml up
@@ -232,7 +236,7 @@ docker compose -f docker-compose.with-env.yml up
232236

233237
Wait until all the services are up and running.
234238

235-
Congratulations 🥳, you just started your own GraphQL Hive instance.
239+
Congratulations 🥳, you just started your own Hive Console instance.
236240

237241
You'll notice the folder named `.hive` at your root directory that has been mounted from docker
238242
representing the volumes for the different storages used by Hive services like `postgres` and
@@ -242,19 +246,19 @@ representing the volumes for the different storages used by Hive services like `
242246
> Note: deleting this directory will end up with a loss of data, as this directory is acting as a
243247
> volume for storing the data from Hive dependencies: database and storage
244248
245-
## Testing GraphQL Hive
249+
## Testing Hive Console
246250

247-
Visit `http://localhost:8080` in your browser and start using GraphQL Hive! The usage reporting
251+
Visit `http://localhost:8080` in your browser and start using Hive Console! The usage reporting
248252
endpoint is bound to `http://localhost:8081`. The GraphQL API is bound to `http://localhost:8082`.
249253
The artifacts bucket is bound to `http://localhost:8083`.
250254

251-
Firstly, you can head to `http://localhost:8080` in your browser and start using GraphQL Hive!
255+
Firstly, you can head to `http://localhost:8080` in your browser and start using Hive Console!
252256
You'll need to Sign Up for an account by inputting your email and password. And once you do you'll
253257
see your personal organization that has been automatically created for you by default.
254258

255259
### Creating first project and target
256260

257-
Now that we have GraphQL Hive setup locally, signed up and logged into our dashboard. We can start
261+
Now that we have Hive Console setup locally, signed up and logged into our dashboard. We can start
258262
creating our first project which we're going to push graphql schemas to.
259263

260264
So you're going to click on the `Create a Project` button on the top right, give it a name and
@@ -351,7 +355,7 @@ the `hive.json` config file then add the following contents, while replacing the
351355
}
352356
```
353357

354-
Now we're all setup to use the GraphQL Hive CLI against our Setup!
358+
Now we're all setup to use the Hive CLI against our Setup!
355359

356360
We can publish our first schema by using:
357361

@@ -372,19 +376,19 @@ Go to the `Schema` tab in your project target and you're going to see your lates
372376

373377
## Next Steps
374378

375-
After doing your first testing with GraphQL Hive you should consider the following steps:
379+
After doing your first testing with Hive Console you should consider the following steps:
376380

377381
- Evaluate whether you want to run Databases yourself within Docker or instead use a managed
378382
database service.
379383
- Set up backups for your data.
380-
- Set up a CD pipeline for deploying GraphQL Hive to your Cloud Provider or bare-metal server of
384+
- Set up a CD pipeline for deploying Hive Console to your Cloud Provider or bare-metal server of
381385
choice (e.g. a Kubernetes cluster or Docker Swarm)
382-
- Set up a monitoring solution for your GraphQL Hive instance (leverage healthchecks, sentry error
386+
- Set up a monitoring solution for your Hive Console instance (leverage healthchecks, sentry error
383387
reporting, prometheus metrics, etc.).
384388
- Configure the `emails` service to use a real email provider (by default it uses `sendmail`).
385-
- Watch and follow the [GraphQL Hive GitHub repository](https://github.com/graphql-hive/console) for
389+
- Watch and follow the [Hive Console GitHub repository](https://github.com/graphql-hive/console) for
386390
new releases and updates.
387-
- Set up a weekly reminder for updating your GraphQL Hive instance to the latest version and
391+
- Set up a weekly reminder for updating your Hive Console instance to the latest version and
388392
applying maintenance.
389393
- Get yourself familiar with SuperTokens and follow their changelogs in order to keep your
390394
SuperTokens instance up-to-date.

0 commit comments

Comments
 (0)