diff --git a/packages/website/docs/getting-started/deployment/01-background.md b/packages/website/docs/getting-started/deployment/01-background.md index 820a8083..96458351 100644 --- a/packages/website/docs/getting-started/deployment/01-background.md +++ b/packages/website/docs/getting-started/deployment/01-background.md @@ -1,7 +1,14 @@ # Background -There are several ways to deploy Apollo. Here we'll review the different parts -of Apollo that each deployment strategy will need to consider. +A full deployment of a collaborative Apollo instance is made up of several +different components. When setting up Apollo, you'll have to decide how you +want to handle each of these components. We provide some examples of how to +deploy Apollo, but the deployment can be customized to fit your needs. For +example, you may want to utilize an existing MongoDB installation (perhaps +managed by your institution) and deploy the rest of Apollo using Docker. + +Here we'll review the different parts of Apollo that each deployment strategy +will need to consider. ## Basic components @@ -43,3 +50,17 @@ The Apollo Collaboration Server stores its data in a MongoDB database. Since the server uses some specialized MongoDB functionality, the database needs to be in a replica set configuration. The database can be on the same machine as the collaboration server, or it can be external. + +## Deployment examples + +- [Deploying with Docker](02-docker-compose.md) +- Other examples coming soon + +## Customizing your deployment + +Our deployment examples cover setting up Apollo with the most common default +settings and guest user access. You'll most likely want to then configure user +logins, which we cover in our [Login Management](03-login-management.md) guide. + +We also cover more options for customizing Apollo in our +[Configuration options](04-configuration-options.md) guide. \ No newline at end of file diff --git a/packages/website/docs/getting-started/deployment/02-docker-compose.md b/packages/website/docs/getting-started/deployment/02-docker-compose.md index 8a580a91..79e58e99 100644 --- a/packages/website/docs/getting-started/deployment/02-docker-compose.md +++ b/packages/website/docs/getting-started/deployment/02-docker-compose.md @@ -1,7 +1,7 @@ # Deploying with Docker Compose One way to deploy Apollo is to use Docker Compose to organize all the needed -pieces. This is what we use to deploy our demo Apollo site. +pieces. This is what the Apollo developers use to deploy our demo Apollo site. ## Prerequisites @@ -50,8 +50,6 @@ MONGODB_URI=mongodb://mongo-node-1:27017,mongo-node-2:27018/apolloDb?replicaSet= FILE_UPLOAD_FOLDER=/data/uploads JWT_SECRET=some-secret-value SESSION_SECRET=some-other-secret-value -GOOGLE_CLIENT_ID=1000521104117-bhd8r4v11cc053g0b80ui00ss9s5fitv.apps.googleusercontent.com -GOOGLE_CLIENT_SECRET=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 ALLOW_ROOT_USER=true ROOT_USER_PASSWORD=some-secret-password ALLOW_GUEST_USER=true diff --git a/packages/website/docs/getting-started/deployment/04-configuration-options.md b/packages/website/docs/getting-started/deployment/04-configuration-options.md new file mode 100644 index 00000000..913caf4b --- /dev/null +++ b/packages/website/docs/getting-started/deployment/04-configuration-options.md @@ -0,0 +1 @@ +# Apollo configuration options