{"id":31040452,"url":"https://github.com/freedom-guard/freedom-core","last_synced_at":"2025-09-14T08:48:42.630Z","repository":{"id":313506272,"uuid":"1051656365","full_name":"Freedom-Guard/Freedom-Core","owner":"Freedom-Guard","description":"Freedom-Core is an open-source, cross-platform tool designed to manage and execute multiple networking cores (like Xray, sing-box, or future modules) via a lightweight API and CLI.","archived":false,"fork":false,"pushed_at":"2025-09-14T05:43:05.000Z","size":33396,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":0,"default_branch":"main","last_synced_at":"2025-09-14T06:18:32.791Z","etag":null,"topics":["docker","golang","sing-box","vpn","xray-core"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Freedom-Guard.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"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,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2025-09-06T13:05:12.000Z","updated_at":"2025-09-14T05:43:09.000Z","dependencies_parsed_at":"2025-09-06T15:21:31.107Z","dependency_job_id":"006623e3-3f76-4bd3-ae7c-360c5cdb7a66","html_url":"https://github.com/Freedom-Guard/Freedom-Core","commit_stats":null,"previous_names":["freedom-guard/freedom-core"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/Freedom-Guard/Freedom-Core","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freedom-Guard%2FFreedom-Core","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freedom-Guard%2FFreedom-Core/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freedom-Guard%2FFreedom-Core/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freedom-Guard%2FFreedom-Core/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Freedom-Guard","download_url":"https://codeload.github.com/Freedom-Guard/Freedom-Core/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Freedom-Guard%2FFreedom-Core/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":275082349,"owners_count":25402339,"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","status":"online","status_checked_at":"2025-09-14T02:00:10.474Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["docker","golang","sing-box","vpn","xray-core"],"created_at":"2025-09-14T08:48:39.766Z","updated_at":"2025-09-14T08:48:42.613Z","avatar_url":"https://github.com/Freedom-Guard.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Freedom-Core 🚀\n\n![Build](https://img.shields.io/github/actions/workflow/status/Freedom-Guard/freedom-core/go.yml?branch=main)\n![Go Version](https://img.shields.io/badge/Go-1.22+-blue)\n![License](https://img.shields.io/github/license/Freedom-Guard/Freedom-Core)\n![Docker Pulls](https://img.shields.io/docker/pulls/freedom-guard/freedom-core)\n\n**Freedom-Core** is an open-source, cross-platform tool designed to manage and execute multiple networking cores (like Xray, sing-box, or future modules) via a lightweight API and CLI. It provides a secure, flexible, and easy-to-use foundation for network operations, automation, and dashboard integration.\n\n---\n\n## 🌟 Key Features\n\n- Manage multiple cores: Xray, sing-box, and future modules.\n- Open a custom port to receive API commands.\n- Cross-platform executable support: Windows (.exe), Linux, macOS.\n- Lightweight Go-based service – can run natively or in containers.\n- Optional Docker deployment for convenience.\n- CLI interface for local control and notifications.\n- Designed for integration with web dashboards or automation tools.\n\n---\n\n## 🛠️ Quick Start\n\n### Prerequisites\n\n- [Go 1.22+](https://golang.org/dl/) (for development and local builds)\n- Optional: [Docker \u0026 Docker Compose](https://docs.docker.com/) (for containerized deployment)\n\n---\n\n### 1. Clone the Repository\n\n```bash\ngit clone https://github.com/Freedom-Guard/freedom-core.git\ncd freedom-core\n````\n\n---\n\n### 2. Run Locally (Native)\n\n```bash\ngo run cmd/server/main.go\n```\n\nOr build an executable:\n\n```bash\n# Windows\ngo build -o freedom-core.exe ./cmd/server\n\n# Linux / macOS\ngo build -o freedom-core ./cmd/server\n```\n\n* The service will start and show:\n\n```\nFreedom-Core is running... 🚀\n```\n\n* By default, it opens port `8087` for API commands.\n\n---\n\n### 3. Run with Docker (Optional)\n\n```bash\ndocker-compose up --build -d\n```\n\n* The service will run on port `8087`.\n* Useful for isolated environments, but not required.\n\n---\n\n## 📌 Supported Cores\n\n* **Xray** (vNext modules supported)\n* **sing-box** (future)\n* Other custom networking cores can be integrated via plugin modules.\n\n---\n\n## 📌 Roadmap\n\n* [ ] Add CLI commands: `start`, `stop`, `status`\n* [ ] Implement multi-core runner (Xray + sing-box + future)\n* [ ] Full REST API: `/start`, `/stop`, `/config`, `/status`\n* [ ] Web dashboard integration\n* [ ] Publish first stable release (v0.1.0)\n* [ ] Notifications for core events\n\n---\n\n## 📁 Project Structure\n\n```\nfreedom-core/\n├── cmd/                 # Entry point of the application\n├── internal/            # Core logic (API, runner, notifier)\n├── pkg/                 # Optional reusable packages\n├── config/              # Configuration files (JSON/YAML)\n├── docker/              # Docker-related files\n├── .github/workflows/   # CI/CD configuration\n├── Dockerfile\n├── docker-compose.yml\n├── README.md\n└── go.mod\n```\n\n---\n\n## 💡 Contribution\n\nFreedom-Core is fully open-source! Contributions, ideas, and improvements are welcome.\n\n* Fork the repository\n* Create a new branch\n* Commit your changes\n* Submit a Pull Request\n\nPlease follow standard Go conventions and write clean, maintainable code.\n\n---\n\n## ⚖️ License\n\nFreedom-Core is released under the [Apache 2.0](LICENSE). You are free to use, modify, and distribute it.\n\n---\n\n## 📣 Contact \u0026 Support\n\nFor questions, discussions, or feature requests:\n\n* GitHub Issues: [https://github.com/Freedom-Guard/freedom-core/issues](https://github.com/Freedom-Guard/freedom-core/issues)\n* GitHub Discussions (future): TBD","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreedom-guard%2Ffreedom-core","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffreedom-guard%2Ffreedom-core","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffreedom-guard%2Ffreedom-core/lists"}