Skip to content

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

57 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Freedom-Core πŸš€

Build Go Version License Docker Pulls

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.


🌟 Key Features

  • Manage multiple cores: Xray, sing-box, and future modules.
  • Open a custom port to receive API commands.
  • Cross-platform executable support: Windows (.exe), Linux, macOS.
  • Lightweight Go-based service – can run natively or in containers.
  • Optional Docker deployment for convenience.
  • CLI interface for local control and notifications.
  • Designed for integration with web dashboards or automation tools.

πŸ› οΈ Quick Start

Prerequisites


2. Run Locally (Native)

go run cmd/server/main.go

Or build an executable:

# Windows 64-bit
go build -o freedom-core.exe ./cmd/server

# Windows 32-bit
GOOS=windows GOARCH=386 go build -o freedom-core-x86.exe ./cmd/server

# Linux 64-bit
go build -o freedom-core ./cmd/server

# macOS Intel (x64)
GOOS=darwin GOARCH=amd64 go build -o freedom-core-macos-x64 ./cmd/server

# macOS Apple Silicon (ARM64)
GOOS=darwin GOARCH=arm64 go build -o freedom-core-macos-arm64 ./cmd/server
  • The service will start and show:
Freedom-Core is running... πŸš€
  • By default, it opens port 8087 for API commands.

3. Run with Docker (Optional)

docker-compose up --build -d
  • The service will run on port 8087.
  • Useful for isolated environments, but not required.

πŸ“Œ Supported Cores

  • Xray (vNext modules supported)
  • sing-box (future)
  • Other custom networking cores can be integrated via plugin modules.

πŸ“Œ Roadmap

  • Add CLI commands: start, stop, status
  • Implement multi-core runner (Xray + sing-box + future)
  • Full REST API: /start, /stop, /config, /status
  • Web dashboard integration
  • Publish first stable release (v0.1.0)
  • Notifications for core events

πŸ“ Project Structure

freedom-core/
β”œβ”€β”€ cmd/                 # Entry point of the application
β”œβ”€β”€ internal/            # Core logic (API, runner, notifier)
β”œβ”€β”€ pkg/                 # Optional reusable packages
β”œβ”€β”€ config/              # Configuration files (JSON/YAML)
β”œβ”€β”€ docker/              # Docker-related files
β”œβ”€β”€ .github/workflows/   # CI/CD configuration
β”œβ”€β”€ Dockerfile
β”œβ”€β”€ docker-compose.yml
β”œβ”€β”€ README.md
└── go.mod

πŸ’‘ Contribution

Freedom-Core is fully open-source! Contributions, ideas, and improvements are welcome.

  • Fork the repository
  • Create a new branch
  • Commit your changes
  • Submit a Pull Request

Please follow standard Go conventions and write clean, maintainable code.


βš–οΈ License

Freedom-Core is released under the Apache 2.0. You are free to use, modify, and distribute it.


πŸ“£ Contact & Support

For questions, discussions, or feature requests:

About

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.

Topics

Resources

Stars

Watchers

Forks

Releases

Packages

Contributors

Languages