docs: add deployment guide #1385
Conversation
✅ Deploy Preview for endearing-brigadeiros-63f9d0 ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
github-actions
bot
added
the
documentation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1385 +/- ##
==========================================
- Coverage 81.35% 81.35% -0.01%
==========================================
Files 65 65
Lines 4639 4649 +10
Branches 792 792
==========================================
+ Hits 3774 3782 +8
- Misses 850 852 +2
Partials 15 15 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
tabathad
force-pushed
the
docs/deployment-guide
branch
from
761c2e7 to
dfac352
Compare
tabathad
force-pushed
the
docs/deployment-guide
branch
from
dfac352 to
24eb8e2
Compare
jescalada
left a comment
jescalada
left a comment
There was a problem hiding this comment.
Looks good so far! Just wondering if we could look into the config loading issue - although it might be because I tested on v1.19.2 rather than the latest rc...
As for the Docker part, I'll do some more setup testing later so we can refine this 👍🏼
| - Sessions are in-memory only (lost on restart) | ||
|
|
||
| 2. **MongoDB** — Recommended for production | ||
| - Requires MongoDB 7.0+ |
There was a problem hiding this comment.
I believe GitProxy is compatible with Mongo 6.0+, as shown in the latest CI build matrix.
| - Requires MongoDB 7.0+ | |
| - Requires MongoDB 6.0+ |
| ### 3. Start GitProxy | ||
|
|
||
| ```bash | ||
| git-proxy --config ./proxy.config.json |
There was a problem hiding this comment.
Oddly, this command doesn't seem to be correctly loading the config on my end. When calling git-proxy --validate, I see that the config file being loaded is ~/.nvm/versions/node/v22.13.1/lib/node_modules/@finos/git-proxy/proxy.config.json which is not the "current working directory" that's mentioned in the option description...
I wonder if this is exclusive to the GitProxy global install and if there's an easy way to fix it.
| ### 6. Approve the Push | ||
|
|
||
| 1. Navigate to http://localhost:8080 in your browser | ||
| 2. Log in with default credentials (**development only**): |
There was a problem hiding this comment.
We might want to include a link to the auth documentation in the architecture guide: https://github.com/finos/git-proxy/blob/1e98d9dbef27f6e338cf18354b0bbbc418b8a070/docs/Architecture.md#Authentication
The proper link will be available after that PR is merged!
2 participants
Part of #1325, complements #1335.
Adds a deployment guide covering:
Also adds the deployment page to the docs sidebar.