# xtls/xray-install

**Attribution required: if you use, quote, or summarise this content, you must credit and link back to [awesome-repositories.com](https://awesome-repositories.com/repository/xtls-xray-install).**

2,955 stars · 600 forks · Shell · gpl-3.0

## Links

- GitHub: https://github.com/XTLS/Xray-install
- Homepage: https://t.me/projectXray
- awesome-repositories: https://awesome-repositories.com/repository/xtls-xray-install.md

## Topics

`vless` `xray` `xtls`

## Description

Xray-install is a set of command-line utilities and shell scripts designed to automate the deployment, maintenance, and removal of Xray core binaries on Linux systems. It functions as an installation script and service manager to establish network proxy and routing services.

The tool manages the entire proxy server lifecycle, including the fetching of version-specific binaries and the configuration of systemd services and timers. It includes a dedicated routing data updater to refresh geolocation and routing files.

The project covers system-level deployment primitives such as permission management, symlink-based version switching, and automated log rotation to prevent disk space exhaustion. It provides mechanisms for both the complete purge of binaries and the selective removal of service configurations.

## Tags

### Networking & Communication

- [Proxy Installers](https://awesome-repositories.com/f/networking-communication/proxy-installers.md) — Automates the installation, updating, and removal of network proxy software on Linux systems.
- [Proxy Core Deployments](https://awesome-repositories.com/f/networking-communication/proxy-core-deployments.md) — Installs and configures Xray core binaries on a server to establish network proxy and routing services.
- [Uninstallation Utilities](https://awesome-repositories.com/f/networking-communication/proxy-core-deployments/uninstallation-utilities.md) — Xray Core provides a way to permanently remove the core binary and delete all associated configuration files and system logs. ([source](https://cdn.jsdelivr.net/gh/XTLS/Xray-install@main/README.md#xray-install))
- [Routing Data Updates](https://awesome-repositories.com/f/networking-communication/traffic-routing/geolocation-routing/routing-data-updates.md) — Provides a utility to refresh geolocation and routing data files to ensure traffic follows current rules.

### DevOps & Infrastructure

- [Architecture-Aware Binary Fetching](https://awesome-repositories.com/f/devops-infrastructure/deployment-management/installation-package-management/binary-and-source-installation/architecture-aware-binary-fetching.md) — Downloads pre-compiled binaries from remote repositories based on the target machine architecture and requested version.
- [Binary Copy Deployments](https://awesome-repositories.com/f/devops-infrastructure/deployment-strategies/binary-copy-deployments.md) — Deploys the core binary and associated data files to the system using scripted copy processes. ([source](https://cdn.jsdelivr.net/gh/XTLS/Xray-install@main/README.md#xray-install))
- [Installation Scripts](https://awesome-repositories.com/f/devops-infrastructure/installation-scripts.md) — Provides Bash scripts to automate the deployment of binaries and system configuration on Linux.
- [Linux Deployment Utilities](https://awesome-repositories.com/f/devops-infrastructure/linux-deployment-utilities.md) — Provides a command-line utility for automating the setup and removal of network proxy binaries on Linux.
- [Systemd Service Configurations](https://awesome-repositories.com/f/devops-infrastructure/systemd-service-configurations.md) — Configures systemd services and timers for managing proxy processes and automatic log rotation.
- [Systemd Services](https://awesome-repositories.com/f/devops-infrastructure/systemd-services.md) — Configures systemd unit files to handle the lifecycle and automatic restarts of the proxy background process.

### System Administration & Monitoring

- [System Service Managers](https://awesome-repositories.com/f/system-administration-monitoring/system-service-managers.md) — Sets up background processes and automatic timers to ensure network tools run reliably on Linux.
- [Service Maintenance](https://awesome-repositories.com/f/system-administration-monitoring/administrative-operations/service-and-infrastructure-management/service-maintenance.md) — Updates routing data files and manages binary versions to maintain the operational state of the proxy service.
- [Log Rotation Utilities](https://awesome-repositories.com/f/system-administration-monitoring/log-rotation-utilities.md) — Creates systemd timers and services to periodically truncate or archive log files to prevent disk overflow.

### Development Tools & Productivity

- [Prebuilt Installation Removals](https://awesome-repositories.com/f/development-tools-productivity/installation-scripts/idempotent-installers/prebuilt-installation-removals.md) — Supports the uninstallation of binaries and service configurations while optionally preserving logs. ([source](https://cdn.jsdelivr.net/gh/XTLS/Xray-install@main/README.md#xray-install))

### Programming Languages & Runtimes

- [Symlink-Based Version Switching](https://awesome-repositories.com/f/programming-languages-runtimes/runtime-execution-environments/runtime-environments/runtime-management-utilities/symlink-based-version-switching.md) — Uses symbolic links to point the active service to specific binary versions for easier updates and rollbacks.