docs: unify repo and website docs#1487
Open
jescalada wants to merge 14 commits intofinos:mainfrom
Open
Conversation
✅ Deploy Preview for endearing-brigadeiros-63f9d0 canceled.
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1487 +/- ##
=======================================
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. 🚀 New features to boost your workflow:
|
9d5cf44 to
8bd81b8
Compare
Contributor
Author
|
@finos/git-proxy-maintainers Would appreciate another look here! |
66 tasks
kriswest
requested changes
May 7, 2026
| - Chain: A set of **processors** that are applied to an action (i.e. a `git push` operation) before requesting review from a user with permission to approve pushes | ||
| - Processor: AKA `Step`. A specific step in the chain where certain rules are applied. See the [list of default processors](./Processors.md) for more details.` | ||
| - Processor: AKA `Step`. A specific step in the chain where certain rules are applied. See the [list of default processors](/docs/architecture/processors.md) for more details.` | ||
| - Plugin: A custom processor that can be added externally to extend GitProxy's default policies. See the [plugin guide](https://git-proxy.finos.org/docs/development/plugins) for more details. |
Contributor
There was a problem hiding this comment.
Links with the full URL open in a separate window. Removing it makes them navigate within docusaurus.
Suggested change
| - Plugin: A custom processor that can be added externally to extend GitProxy's default policies. See the [plugin guide](https://git-proxy.finos.org/docs/development/plugins) for more details. | |
| - Plugin: A custom processor that can be added externally to extend GitProxy's default policies. See the [plugin guide](/docs/development/plugins) for more details. |
| - Backend-for-frontend (BFF) Service API, Express app (`/src/service`): Handles UI requests, user authentication to GitProxy (not to Git), database operations and some of the logic for rejection/approval. Runs by default on port `8080`, and can be configured with the `GIT_PROXY_UI_HOST` and `GIT_PROXY_UI_PORT` environment variables. | ||
| - Passport: The [library](https://www.passportjs.org/) used to authenticate to the GitProxy API (not the proxy itself - this depends on the Git `user.email`). Supports multiple authentication methods by default ([Local](#local), [AD](#activedirectory), [OIDC](#openid-connect)). | ||
| - Routes: All the API endpoints used by the UI and proxy to perform operations and fetch or modify GitProxy's state. Except for custom plugin and processor development, there is no need for users or GitProxy administrators to interact with the API directly. | ||
| - Configuration (`/src/config`): Loads and validates the configuration from `proxy.config.json`, or any provided config file. Allows customising several aspects of GitProxy, including databases, authentication methods, predefined allowed repositories, commit blocking rules and more. For a full list of configurable parameters, check the [config file schema reference](https://git-proxy.finos.org/docs/configuration/reference/). |
Contributor
There was a problem hiding this comment.
Links with the full URL open in a separate window. Removing it makes them navigate within docusaurus.
Suggested change
| - Configuration (`/src/config`): Loads and validates the configuration from `proxy.config.json`, or any provided config file. Allows customising several aspects of GitProxy, including databases, authentication methods, predefined allowed repositories, commit blocking rules and more. For a full list of configurable parameters, check the [config file schema reference](/docs/configuration/reference/). |
| - For example, [`checkCommitMessages`](./Processors.md#checkcommitmessages) which reads the configuration and matches the string patterns provided with the commit messages in the push in order to block it. | ||
| - For example, [`checkCommitMessages`](/docs/architecture/processors.md#checkcommitmessages) which reads the configuration and matches the string patterns provided with the commit messages in the push in order to block it. | ||
| - Custom policies: | ||
| - Plugins: Push/pull plugins provide more flexibility for implementing an organization's rules. For more information, see the [guide on writing your own plugins](https://git-proxy.finos.org/docs/development/plugins). |
Contributor
There was a problem hiding this comment.
Suggested change
| - Plugins: Push/pull plugins provide more flexibility for implementing an organization's rules. For more information, see the [guide on writing your own plugins](https://git-proxy.finos.org/docs/development/plugins). | |
| - Plugins: Push/pull plugins provide more flexibility for implementing an organization's rules. For more information, see the [guide on writing your own plugins](/docs/development/plugins). |
| - Password: `admin` | ||
|
|
||
| See the [Authentication](https://github.com/finos/git-proxy/blob/main/docs/Architecture.md#authentication) section of the architecture guide for more details. | ||
| See the [Authentication](https://github.com/finos/git-proxy/blob/main/website/architecture/architecture.md#authentication) section of the architecture guide for more details. |
Contributor
There was a problem hiding this comment.
Suggested change
| See the [Authentication](https://github.com/finos/git-proxy/blob/main/website/architecture/architecture.md#authentication) section of the architecture guide for more details. | |
| See the [Authentication](/docs/architecture/architecture.md#authentication) section of the architecture guide for more details. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Fixes #1407.
Also pins the
lodashwebsite dependency to fix a CI failure from this advisory, which is necessary asdocusaurusnever seems to fix their dep vulnerabilities...Preview link: https://deploy-preview-1487.git-proxy.preview.finos.org/