https://github.com/defguard/proxy
https://github.com/defguard/proxy
Last synced: 3 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/defguard/proxy
- Owner: DefGuard
- License: other
- Created: 2023-07-25T08:45:24.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-04-01T08:38:01.000Z (3 months ago)
- Last Synced: 2025-04-01T08:40:27.558Z (3 months ago)
- Language: TypeScript
- Size: 1.78 MB
- Stars: 6
- Watchers: 5
- Forks: 2
- Open Issues: 13
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
This service is meant to serve as a proxy for a subset of functionalities of [defguard](https://github.com/DefGuard/defguard) core which require public access.
It provides a public REST API and communicates with core over [gRPC](https://github.com/DefGuard/proto).
To learn more about the system see our [documentation](https://defguard.gitbook.io).
## Quick start
If you already have your defguard instance running you can set up a proxy by following our [deployment guide](https://defguard.gitbook.io/defguard/features/setting-up-your-instance/docker-compose).
## Documentation
See the [documentation](https://defguard.gitbook.io) for more information.
## Community and Support
Find us on Matrix: [#defguard:teonite.com](https://matrix.to/#/#defguard:teonite.com)
## Contribution
Please review the [Contributing guide](https://defguard.gitbook.io/defguard/for-developers/contributing) for information on how to get started contributing to the project. You might also find our [environment setup guide](https://defguard.gitbook.io/defguard/for-developers/dev-env-setup) handy.
## Development
Clone repository:
```bash
[email protected]:DefGuard/client.git
```
Initialize `proto` submodule:
```bash
git submodule update --init --recursive
```
To run API server:
```bash
cargo run
```
To run webapp dev server:
```bash
cd web/
pnpm install
pnpm run dev
```