Skip to content

Commit

Permalink
Add deployment guide
Browse files Browse the repository at this point in the history
  • Loading branch information
JBorrow committed Jan 8, 2025
1 parent e76dd1e commit da5d4db
Showing 1 changed file with 24 additions and 1 deletion.
25 changes: 24 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,8 @@ HIPPO
The HIerarchical Product Post Office
------------------------------------

![Docker Image Version](https://img.shields.io/docker/v/simonsobs/hippo)

Hippo is a piece of software aimed at making FAIR (Findable, Attributable, Interoperable,
and Reuseable) data access easier. Through the use of the very flexible MongoDB for
_true_ metadata storage and MinIO as a data storage backend, hippo provides metadata-driven
Expand Down Expand Up @@ -79,4 +81,25 @@ There are a number of important configuration variables:

Secrets can be loaded from `/run/secrets` automatically, so long as they have the same file name as their environment variable.

For GitHub integration, your callback URL needs to be $URL/web.
For GitHub integration, your callback URL needs to be $URL/web.


Deployment Guide
----------------

To deploy, you need to set up a MongoDB server and a Minio server. This will involve:

- Creating a MongoDB password, saved as a secret.
- Creating a MongoDB URI with this password, saved as a secret.
- Creating a Minio access token, saved as a secret.
- Creating a WEB_JWT_SECRET, saved as a secret.
- Creating the GitHub client ID and secret, saved as a secret.

Then, you can deploy your MongoDB and Minio servers. Do not forget to set up storage
for their backends to ensure persistence across restarts.

Note that we provide a docker compose file in the main repository as an example. This
should show you how the containers interact.

With the two backends set up, you can deploy the container. You can build it yourself,
or use the hosted version.

0 comments on commit da5d4db

Please sign in to comment.