Skip to content

docs: add deployment guide#1385

Merged
jescalada merged 9 commits intofinos:mainfrom
tabathad:docs/deployment-guide
Mar 17, 2026
Merged

docs: add deployment guide#1385
jescalada merged 9 commits intofinos:mainfrom
tabathad:docs/deployment-guide

Conversation

@tabathad
Copy link
Copy Markdown
Contributor

@tabathad tabathad commented Feb 6, 2026

Part of #1325, complements #1335.

Adds a deployment guide covering:

  • Prerequisites
  • Quick start walkthrough
  • Docker deployment
  • Git client configuration
  • Production considerations

Also adds the deployment page to the docs sidebar.

@netlify
Copy link
Copy Markdown

netlify Bot commented Feb 6, 2026

Deploy Preview for endearing-brigadeiros-63f9d0 canceled.

Name Link
🔨 Latest commit a13f35c
🔍 Latest deploy log https://app.netlify.com/projects/endearing-brigadeiros-63f9d0/deploys/69b97e7fe9fb640008f10e27

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Feb 6, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Feb 6, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 89.66%. Comparing base (cc5e5f3) to head (a13f35c).
⚠️ Report is 10 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #1385   +/-   ##
=======================================
  Coverage   89.66%   89.66%           
=======================================
  Files          68       68           
  Lines        4869     4869           
  Branches      888      888           
=======================================
  Hits         4366     4366           
  Misses        485      485           
  Partials       18       18           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@tabathad tabathad force-pushed the docs/deployment-guide branch from 761c2e7 to dfac352 Compare February 6, 2026 12:40
@tabathad tabathad force-pushed the docs/deployment-guide branch from dfac352 to 24eb8e2 Compare February 6, 2026 14:44
Copy link
Copy Markdown
Contributor

@jescalada jescalada left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 👍🏼

Comment thread website/docs/deployment.mdx Outdated
Comment thread website/docs/deployment.mdx
Comment thread website/docs/deployment.mdx
tabathad and others added 4 commits February 10, 2026 13:51
Co-authored-by: Juan Escalada <97265671+jescalada@users.noreply.github.com>
Signed-off-by: Tabatha DiDomenico <tabatha@gr-oss.io>
@tabathad tabathad requested a review from a team as a code owner February 18, 2026 13:42
tabathad and others added 2 commits February 23, 2026 13:20
Signed-off-by: Tabatha DiDomenico <tabatha.didomenico@gresearch.co.uk>
@kriswest
Copy link
Copy Markdown
Contributor

kriswest commented Mar 11, 2026

Love to see this going in for v2 and would also like to know why the preview build is failing.

I think we could include some content on loadbalancing. I think the app should loadbalance fine (when using Mongodb) - even if you usually only have one node, knowing that you can deploy a second would enable zero-downtime deployments. I'll raise an issue to check if anyone is actively doing this with their deployment.

Edit: I note the comment about MongoDB being required for multi-instance deployments. We could go a little further as Git proxy does use local storage during processing but its ephemeral at the moment and relates to only a single request (doesn't need to persist). That will not change with @fabiovincenzi's caching contribution - it just means the nodes will have different caches (and you may want to latch users to particular nodes where possible to make best use of caches).

Copy link
Copy Markdown
Contributor

@kriswest kriswest left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - although the node version info is about to become out-of-date - @jescalada @1462 will need rebasing after this merges and will need to update the node version range in deployment.mdx.

This should merge now so that it goes out with 2.0.0

There is a check failing, but I think its not the PRs fault, but a timeout and just needs to be re-run.

@jescalada jescalada merged commit 758b2db into finos:main Mar 17, 2026
34 of 36 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Review and improve Git proxy getting started and config documentation

3 participants