{"id":20556422,"url":"https://github.com/flagsmith/edge-proxy","last_synced_at":"2025-04-14T13:07:30.177Z","repository":{"id":192618385,"uuid":"433873112","full_name":"Flagsmith/edge-proxy","owner":"Flagsmith","description":"The Flagsmith Edge Proxy Docker Image","archived":false,"fork":false,"pushed_at":"2025-04-07T11:53:01.000Z","size":250,"stargazers_count":5,"open_issues_count":10,"forks_count":4,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-07T12:38:00.722Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Flagsmith.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-12-01T15:05:17.000Z","updated_at":"2025-04-07T11:48:24.000Z","dependencies_parsed_at":null,"dependency_job_id":"4348930e-a5f4-42d0-89b2-8e158bcdb81f","html_url":"https://github.com/Flagsmith/edge-proxy","commit_stats":null,"previous_names":["flagsmith/edge-proxy"],"tags_count":29,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flagsmith%2Fedge-proxy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flagsmith%2Fedge-proxy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flagsmith%2Fedge-proxy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Flagsmith%2Fedge-proxy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Flagsmith","download_url":"https://codeload.github.com/Flagsmith/edge-proxy/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248886314,"owners_count":21177643,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-16T03:27:37.957Z","updated_at":"2025-04-14T13:07:29.692Z","avatar_url":"https://github.com/Flagsmith.png","language":"Python","readme":"[![Feature Flag, Remote Config and A/B Testing platform, Flagsmith](https://raw.githubusercontent.com/Flagsmith/flagsmith/main/static-files/hero.png)](https://www.flagsmith.com/)\n\n[![Join the Discord chat](https://img.shields.io/discord/517647859495993347)](https://discord.gg/hFhxNtXzgm)\n\n[Flagsmith](https://flagsmith.com/) is an open source, fully featured, Feature Flag and Remote Config service. Use our\nhosted API, deploy to your own private cloud, or run on-premise.\n\n# Edge Proxy\n\nThe Flagsmith Edge Proxy allows you to run an instance of the Flagsmith Engine close to your servers. If you are running\nFlagsmith within a server-side environment and you want to have very low latency flags, you have two options:\n\n1. Run the Edge Proxy and connect to it from your server-side SDKs\n2. Run your server-side SDKs in [Local Evaluation Mode](https://docs.flagsmith.com/clients/overview#2---local-evaluation).\n\nThe main benefit to running the Edge Proxy is that you reduce your polling requests against the Flagsmith API itself.\n\nThe main benefit to running server side SDKs in [Local Evaluation Mode](https://docs.flagsmith.com/clients/overview#2---local-evaluation) is that you get the lowest possible latency.\n\n## Local development\n\n### Prerequisites\n\n- [Rye](https://rye-up.com/guide/installation/)\n- [Docker](https://docs.docker.com/engine/install/)\n\n### Setup local environment\n\nInstall locked dependencies:\n\n`rye sync --no-lock`\n\nInstall pre-commit hooks:\n\n`pre-commit install`\n\nRun tests:\n\n`rye test`\n\n\n### Build and run Docker image locally\n\n```shell\n# Build image\ndocker build . -t edge-proxy-local\n\n# Run image \ndocker run --rm \\\n  -p 8000:8000 \\\n  edge-proxy-local\n```\n\n## Configuration\n\nSee complete configuration [reference](https://docs.flagsmith.com/deployment/hosting/locally-edge-proxy).\n\nEdge Proxy expects to load configuration from `./config.json`.\n\nCreate an example configuration by running the `edge-proxy-render-config` entrypoint:\n\n```sh\nrye run edge-proxy-render-config\n```\n\nThis will write the default settings to `./config.json`.\n\nHere's how to mount the file into Edge Proxy's Docker container:\n\n```sh\ndocker run -v ./config.json:/app/config.json flagsmith/edge-proxy:latest\n```\n\nYou can specify custom path to `config.json`, e.g.:\n\n```sh\nexport CONFIG_PATH=/\u003cpath-to-config\u003e/config.json\n\nedge-proxy-render-config            # Will write an example configuration to custom path.\nedge-proxy-serve             # Will read configuration from custom path.\n```\n\nYou can also mount to custom path inside container:\n\n```sh\ndocker run \\\n    -e CONFIG_PATH=/var/foo.json \\\n    -v /\u003cpath-to-config\u003e/config.json:/var/foo.json \\\n    flagsmith/edge-proxy:latest\n``` \n\n## Load Testing\n\nYou can send post request with `wrk` like this:\n\n```bash\ncd load-test\nwrk -t10 -c40 -d5 -s post.lua -H 'X-Environment-Key: \u003cyour environment key\u003e' 'http://localhost:8001/api/v1/identities/?identifier=development_user_123456'\n```\n\n## Documentation\n\nSee [Edge Proxy documentation](https://docs.flagsmith.com/advanced-use/edge-proxy).\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflagsmith%2Fedge-proxy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fflagsmith%2Fedge-proxy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fflagsmith%2Fedge-proxy/lists"}