Home

Awesome

<img src="https://raw.githubusercontent.com/VZiChoushaDui/Libertea/master/docs/logo-complete.png" style="width: 300px" />

Libertea

Easily install and manage a multi-protocol, multi-route V2ray VPN server; with advanced user management, automatic routing, domain camouflage, and auto update for users.

Chinese 中文

Farsi فارسی

Table of Contents

<a name='Features'></a>Features

<a name='Requirements'></a>Requirements

<a name='Recommendedconfiguration'></a>Recommended configuration

<a name='Installation'></a>Installation

  1. Buy a domain and point its DNS to a CDN (such as Cloudflare), and set the CDN to Full SSL mode. help

  2. Set your server's IP address to the CDN's DNS record, and make sure CDN is enabled. (Orange cloud icon in Cloudflare)

  3. run the following command on your server and follow the instructions.

    curl -s https://raw.githubusercontent.com/VZiChoushaDui/Libertea/master/bootstrap.sh -o /tmp/bootstrap.sh && bash /tmp/bootstrap.sh install

    The installation may take a few minutes.

<a name='Update'></a>Update

To update, just run the following command on your server:

curl -s https://raw.githubusercontent.com/VZiChoushaDui/Libertea/master/bootstrap.sh -o /tmp/bootstrap.sh && bash /tmp/bootstrap.sh update

<a name='Uninstall'></a>Uninstall

If you want to uninstall Liberta or Liberta-secondary-proxy from your server for any reason, run the following command on your server:

curl -s https://raw.githubusercontent.com/VZiChoushaDui/Libertea/master/bootstrap.sh -o /tmp/bootstrap.sh && bash /tmp/bootstrap.sh uninstall

<a name='Contribution'></a>Contribution

Contributions are welcome! Please feel free to open an issue for any bugs, improvements and ideas; or open a pull request if you want to contribute code. If you're opening a pull request, make sure to send it to the devel branch of this repository.

<a name='FrequentlyAskedQuestions'></a>Frequently Asked Questions

<a name='DoesLiberteakeepmydomainsandIPssafefrombeingblocked'></a>Does Libertea keep my domains and IPs safe from being blocked?

Libertea uses SSL-based protocols, so the traffic is not distinguishable from normal HTTPS traffic. Also by setting a Camouflage domain to your Libertea installation, the risk of active probing gets reduced. However, GFW may still block your domains and IPs based on usage after a period of time. It is recommended to use multiple domains and secondary proxies, and periodically change your secondary proxy IPs.

<a name='CanIrouteregionaltrafficdirectlywithoutgoingthroughVPN'></a>Can I route regional traffic directly (without going through VPN)?

Yes. In the admin panel, go to the Settings tab, and in the Route regional IPs directly section, select the countries you want to go through directly. This only works for Clash clients.

<a name='CanIsetusagelimitsforusers'></a>Can I set usage limits for users?

Yes. You can set concurrent connection limit, monthly data usage limit, and time limit for each user in the admin panel. Users will be disconnected when they reach their limits.

Please note that the usage limits take effect with a delay of up to 10 minutes.

<a name='SomeofmyserversorCDNplanshavelimitedtraffic.CanIprioritizeservers'></a>Some of my servers or CDN plans have limited traffic. Can I prioritize servers?

Yes. You can set a group for each domain and secondary proxy; users' devices will try first group routes first, and use go to next groups only if those are not available. This way, you can optimize your traffic usage per server/domain according to your needs.

<a name='HowcanIbackupmyLiberteainstallationormoveittoanotherserver'></a>How can I backup my Libertea installation, or move it to another server?

To create a backup from your Libertea, just copy the whole folder /root/libertea.

For example, to move Libertea to your new server, run the following commands on your first server to copy the Libertea folder to your new server:

# Run this on your first server
rsync -avz /root/libertea [new-server-ip]:/root/

When you want to restore it on another server, after copying the folder, just run the Libertea update command on the new server:

# Run this on your new server
curl -s https://raw.githubusercontent.com/VZiChoushaDui/Libertea/master/bootstrap.sh -o /tmp/bootstrap.sh && bash /tmp/bootstrap.sh update

<a name='Iwanttohavemyownwebsiteonthesameserverrunningonport80443.CanIstilluseLibertea'></a>I want to have my own website on the same server running on port 80/443. Can I still use Libertea?

Libertea uses port 80 and 443 for its own purposes and needs to listen to ports 80/443, but you can configure Libertea as a reverse proxy for your website or services. To do this, configure your website/services on http on a different port (e.g. 8080), and then go to the Settings tab in the Libertea admin panel, and set 127.0.0.1:8080 as the Camouflage domain. This way, Libertea will forward all requests to your website.

<a name='CanIuseLiberteawithacustomreverseproxy'></a>Can I use Libertea with a custom reverse proxy?

Libertea's HAProxy needs to be the process listening to ports 80 and 443. If you want more customization (than the one available in the question above), you can use Libertea's HAProxy as your reverse proxy by modifying Libertea's HAProxy configuration located at /root/libertea/haproxy/haproxy.cfg and then run the following command to apply the changes:

docker restart libertea-haproxy

You can check the HAProxy logs to see if the changes are applied correctly:

docker logs -f --tail=100 libertea-haproxy

<a name='CanIusethebetaversionofLibertea'></a>Can I use the beta version of Libertea?

Yes, you can use the beta version of Libertea by running the following command on your server:

export LIBERTEA_BRANCH=beta && curl -s https://raw.githubusercontent.com/VZiChoushaDui/Libertea/master/bootstrap.sh -o /tmp/bootstrap.sh && bash /tmp/bootstrap.sh install

Please note that the beta version may have bugs and issues, and it not guaranteed to be stable.

<a name='HowcanIchangetheLiberteapanelpasswordorpaneldomain'></a>How can I change the Libertea panel password or panel domain?

To change the Libertea panel password, run the install command again on your server:

curl -s https://raw.githubusercontent.com/VZiChoushaDui/Libertea/master/bootstrap.sh -o /tmp/bootstrap.sh && bash /tmp/bootstrap.sh install

Follow the instructions and enter a new domain and/or password when prompted.

<a name='IwanttomodifyLiberteacontributetoLibertea.HowcanIconfigureLiberteafordevelopment'></a>I want to modify Libertea/contribute to Libertea. How can I configure Libertea for development?

You can install Libertea normally, and modify the files in the /root/libertea folder. After modifying the files, you can run the following command to apply the changes:

cd /root/libertea && export ENVIRONMENT="dev" && ./init.sh update

This will rebuild the Libertea Docker containers from scratch to apply your changes.

Please note that if you want to change docker-compose files, you need to modify the docker-compose.dev.yml file instead of docker-compose.yml while in development mode.

You can check the Libertea panel logs by running the following command:

tail -f -n 100 /tmp/libertea-panel.log

and also you can check the Libertea docker logs by running the following command:

cd /root/libertea && docker compose logs -f --tail=100

Feel free to submit your changes as a pull request to the devel branch of this repository if you want to contribute to the project.

<a name='Changelog'></a>Changelog

<a name='v1043'></a>v1043

<a name='v1042'></a>v1042

<a name='v1040'></a>v1040

<a name='v1039'></a>v1039