3x-ui/install.sh
izzzzzi 2fbd1d860d feat: add PostgreSQL support and database configuration options
- Updated Docker configuration to support PostgreSQL as an alternative to SQLite.
- Enhanced DockerEntrypoint.sh to create a database environment file and test PostgreSQL connection.
- Introduced database setup functions in install.sh for PostgreSQL installation and configuration.
- Added database management options in x-ui.sh, including backup and switching between SQLite and PostgreSQL.
- Implemented database configuration retrieval in the web service and controller layers.
- Updated frontend settings to include database configuration options.
- Added translations for new database settings in multiple languages.
2025-05-23 02:00:06 +05:00

369 lines
15 KiB
Bash

#!/bin/bash
red='\033[0;31m'
green='\033[0;32m'
blue='\033[0;34m'
yellow='\033[0;33m'
plain='\033[0m'
cur_dir=$(pwd)
# check root
[[ $EUID -ne 0 ]] && echo -e "${red}Fatal error: ${plain} Please run this script with root privilege \n " && exit 1
# Check OS and set release variable
if [[ -f /etc/os-release ]]; then
source /etc/os-release
release=$ID
elif [[ -f /usr/lib/os-release ]]; then
source /usr/lib/os-release
release=$ID
else
echo "Failed to check the system OS, please contact the author!" >&2
exit 1
fi
echo "The OS release is: $release"
arch() {
case "$(uname -m)" in
x86_64 | x64 | amd64) echo 'amd64' ;;
i*86 | x86) echo '386' ;;
armv8* | armv8 | arm64 | aarch64) echo 'arm64' ;;
armv7* | armv7 | arm) echo 'armv7' ;;
armv6* | armv6) echo 'armv6' ;;
armv5* | armv5) echo 'armv5' ;;
s390x) echo 's390x' ;;
*) echo -e "${green}Unsupported CPU architecture! ${plain}" && rm -f install.sh && exit 1 ;;
esac
}
echo "Arch: $(arch)"
check_glibc_version() {
glibc_version=$(ldd --version | head -n1 | awk '{print $NF}')
required_version="2.32"
if [[ "$(printf '%s\n' "$required_version" "$glibc_version" | sort -V | head -n1)" != "$required_version" ]]; then
echo -e "${red}GLIBC version $glibc_version is too old! Required: 2.32 or higher${plain}"
echo "Please upgrade to a newer version of your operating system to get a higher GLIBC version."
exit 1
fi
echo "GLIBC version: $glibc_version (meets requirement of 2.32+)"
}
check_glibc_version
install_base() {
case "${release}" in
ubuntu | debian | armbian)
apt-get update && apt-get install -y -q wget curl tar tzdata
;;
centos | almalinux | rocky | ol)
yum -y update && yum install -y -q wget curl tar tzdata
;;
fedora | amzn | virtuozzo)
dnf -y update && dnf install -y -q wget curl tar tzdata
;;
arch | manjaro | parch)
pacman -Syu && pacman -Syu --noconfirm wget curl tar tzdata
;;
opensuse-tumbleweed)
zypper refresh && zypper -q install -y wget curl tar timezone
;;
*)
apt-get update && apt install -y -q wget curl tar tzdata
;;
esac
}
gen_random_string() {
local length="$1"
local random_string=$(LC_ALL=C tr -dc 'a-zA-Z0-9' </dev/urandom | fold -w "$length" | head -n 1)
echo "$random_string"
}
install_postgresql() {
echo -e "${green}Installing PostgreSQL...${plain}"
case "${release}" in
ubuntu | debian | armbian)
apt-get update
apt-get install -y postgresql postgresql-contrib
;;
centos | almalinux | rocky | ol)
yum install -y postgresql-server postgresql-contrib
postgresql-setup initdb
;;
fedora | amzn | virtuozzo)
dnf install -y postgresql-server postgresql-contrib
postgresql-setup --initdb
;;
arch | manjaro | parch)
pacman -S --noconfirm postgresql
sudo -u postgres initdb -D /var/lib/postgres/data
;;
opensuse-tumbleweed)
zypper install -y postgresql-server postgresql-contrib
;;
*)
echo -e "${red}Unsupported OS for PostgreSQL installation${plain}"
return 1
;;
esac
# Start and enable PostgreSQL service
systemctl start postgresql
systemctl enable postgresql
if ! systemctl is-active --quiet postgresql; then
echo -e "${red}Failed to start PostgreSQL service${plain}"
return 1
fi
echo -e "${green}PostgreSQL installed and started successfully${plain}"
return 0
}
setup_postgresql_for_xui() {
echo -e "${green}Setting up PostgreSQL for x-ui...${plain}"
local db_name="x_ui"
local db_user="x_ui"
local db_password=$(gen_random_string 16)
# Create database and user
sudo -u postgres psql -c "CREATE DATABASE ${db_name};" 2>/dev/null || true
sudo -u postgres psql -c "CREATE USER ${db_user} WITH PASSWORD '${db_password}';" 2>/dev/null || true
sudo -u postgres psql -c "GRANT ALL PRIVILEGES ON DATABASE ${db_name} TO ${db_user};" 2>/dev/null || true
sudo -u postgres psql -c "ALTER USER ${db_user} CREATEDB;" 2>/dev/null || true
# Create environment file for x-ui
cat > /etc/x-ui/db.env << EOF
DB_TYPE=postgres
DB_HOST=localhost
DB_PORT=5432
DB_NAME=${db_name}
DB_USER=${db_user}
DB_PASSWORD=${db_password}
DB_SSLMODE=disable
DB_TIMEZONE=UTC
EOF
chmod 600 /etc/x-ui/db.env
echo -e "${green}PostgreSQL setup completed${plain}"
echo -e "${yellow}Database: ${db_name}${plain}"
echo -e "${yellow}User: ${db_user}${plain}"
echo -e "${yellow}Password: ${db_password}${plain}"
echo -e "${yellow}Configuration saved to: /etc/x-ui/db.env${plain}"
return 0
}
database_setup() {
echo -e "${green}Database Setup${plain}"
echo -e "Choose your database type:"
echo -e "${green}1.${plain} SQLite (Default, recommended for most users)"
echo -e "${green}2.${plain} PostgreSQL (For high-load environments)"
read -rp "Enter your choice [1-2, default: 1]: " db_choice
case "${db_choice}" in
2)
echo -e "${yellow}Setting up PostgreSQL...${plain}"
# Check if PostgreSQL is already installed
if command -v psql &> /dev/null && systemctl is-active --quiet postgresql; then
echo -e "${yellow}PostgreSQL is already installed and running${plain}"
read -rp "Do you want to use existing PostgreSQL installation? [y/n, default: y]: " use_existing
if [[ "${use_existing}" == "n" || "${use_existing}" == "N" ]]; then
return 1
fi
else
read -rp "PostgreSQL will be installed. Continue? [y/n, default: y]: " install_confirm
if [[ "${install_confirm}" == "n" || "${install_confirm}" == "N" ]]; then
echo -e "${yellow}Using SQLite instead${plain}"
return 0
fi
if ! install_postgresql; then
echo -e "${red}Failed to install PostgreSQL. Using SQLite instead${plain}"
return 0
fi
fi
if ! setup_postgresql_for_xui; then
echo -e "${red}Failed to setup PostgreSQL. Using SQLite instead${plain}"
return 0
fi
echo -e "${green}PostgreSQL setup completed successfully${plain}"
;;
1|"")
echo -e "${green}Using SQLite database (default)${plain}"
# Create empty env file to indicate SQLite usage
mkdir -p /etc/x-ui
cat > /etc/x-ui/db.env << EOF
DB_TYPE=sqlite
EOF
chmod 600 /etc/x-ui/db.env
;;
*)
echo -e "${yellow}Invalid choice. Using SQLite (default)${plain}"
mkdir -p /etc/x-ui
cat > /etc/x-ui/db.env << EOF
DB_TYPE=sqlite
EOF
chmod 600 /etc/x-ui/db.env
;;
esac
return 0
}
config_after_install() {
local existing_hasDefaultCredential=$(/usr/local/x-ui/x-ui setting -show true | grep -Eo 'hasDefaultCredential: .+' | awk '{print $2}')
local existing_webBasePath=$(/usr/local/x-ui/x-ui setting -show true | grep -Eo 'webBasePath: .+' | awk '{print $2}')
local existing_port=$(/usr/local/x-ui/x-ui setting -show true | grep -Eo 'port: .+' | awk '{print $2}')
local server_ip=$(curl -s https://api.ipify.org)
if [[ ${#existing_webBasePath} -lt 4 ]]; then
if [[ "$existing_hasDefaultCredential" == "true" ]]; then
local config_webBasePath=$(gen_random_string 15)
local config_username=$(gen_random_string 10)
local config_password=$(gen_random_string 10)
read -rp "Would you like to customize the Panel Port settings? (If not, a random port will be applied) [y/n]: " config_confirm
if [[ "${config_confirm}" == "y" || "${config_confirm}" == "Y" ]]; then
read -rp "Please set up the panel port: " config_port
echo -e "${yellow}Your Panel Port is: ${config_port}${plain}"
else
local config_port=$(shuf -i 1024-62000 -n 1)
echo -e "${yellow}Generated random port: ${config_port}${plain}"
fi
/usr/local/x-ui/x-ui setting -username "${config_username}" -password "${config_password}" -port "${config_port}" -webBasePath "${config_webBasePath}"
echo -e "This is a fresh installation, generating random login info for security concerns:"
echo -e "###############################################"
echo -e "${green}Username: ${config_username}${plain}"
echo -e "${green}Password: ${config_password}${plain}"
echo -e "${green}Port: ${config_port}${plain}"
echo -e "${green}WebBasePath: ${config_webBasePath}${plain}"
echo -e "${green}Access URL: http://${server_ip}:${config_port}/${config_webBasePath}${plain}"
echo -e "###############################################"
else
local config_webBasePath=$(gen_random_string 15)
echo -e "${yellow}WebBasePath is missing or too short. Generating a new one...${plain}"
/usr/local/x-ui/x-ui setting -webBasePath "${config_webBasePath}"
echo -e "${green}New WebBasePath: ${config_webBasePath}${plain}"
echo -e "${green}Access URL: http://${server_ip}:${existing_port}/${config_webBasePath}${plain}"
fi
else
if [[ "$existing_hasDefaultCredential" == "true" ]]; then
local config_username=$(gen_random_string 10)
local config_password=$(gen_random_string 10)
echo -e "${yellow}Default credentials detected. Security update required...${plain}"
/usr/local/x-ui/x-ui setting -username "${config_username}" -password "${config_password}"
echo -e "Generated new random login credentials:"
echo -e "###############################################"
echo -e "${green}Username: ${config_username}${plain}"
echo -e "${green}Password: ${config_password}${plain}"
echo -e "###############################################"
else
echo -e "${green}Username, Password, and WebBasePath are properly set. Exiting...${plain}"
fi
fi
/usr/local/x-ui/x-ui migrate
}
install_x-ui() {
cd /usr/local/
if [ $# == 0 ]; then
tag_version=$(curl -Ls "https://api.github.com/repos/MHSanaei/3x-ui/releases/latest" | grep '"tag_name":' | sed -E 's/.*"([^"]+)".*/\1/')
if [[ ! -n "$tag_version" ]]; then
echo -e "${red}Failed to fetch x-ui version, it may be due to GitHub API restrictions, please try it later${plain}"
exit 1
fi
echo -e "Got x-ui latest version: ${tag_version}, beginning the installation..."
wget -N -O /usr/local/x-ui-linux-$(arch).tar.gz https://github.com/MHSanaei/3x-ui/releases/download/${tag_version}/x-ui-linux-$(arch).tar.gz
if [[ $? -ne 0 ]]; then
echo -e "${red}Downloading x-ui failed, please be sure that your server can access GitHub ${plain}"
exit 1
fi
else
tag_version=$1
tag_version_numeric=${tag_version#v}
min_version="2.3.5"
if [[ "$(printf '%s\n' "$min_version" "$tag_version_numeric" | sort -V | head -n1)" != "$min_version" ]]; then
echo -e "${red}Please use a newer version (at least v2.3.5). Exiting installation.${plain}"
exit 1
fi
url="https://github.com/MHSanaei/3x-ui/releases/download/${tag_version}/x-ui-linux-$(arch).tar.gz"
echo -e "Beginning to install x-ui $1"
wget -N -O /usr/local/x-ui-linux-$(arch).tar.gz ${url}
if [[ $? -ne 0 ]]; then
echo -e "${red}Download x-ui $1 failed, please check if the version exists ${plain}"
exit 1
fi
fi
if [[ -e /usr/local/x-ui/ ]]; then
systemctl stop x-ui
rm /usr/local/x-ui/ -rf
fi
tar zxvf x-ui-linux-$(arch).tar.gz
rm x-ui-linux-$(arch).tar.gz -f
cd x-ui
chmod +x x-ui
# Check the system's architecture and rename the file accordingly
if [[ $(arch) == "armv5" || $(arch) == "armv6" || $(arch) == "armv7" ]]; then
mv bin/xray-linux-$(arch) bin/xray-linux-arm
chmod +x bin/xray-linux-arm
fi
chmod +x x-ui bin/xray-linux-$(arch)
cp -f x-ui.service /etc/systemd/system/
wget -O /usr/bin/x-ui https://raw.githubusercontent.com/MHSanaei/3x-ui/main/x-ui.sh
chmod +x /usr/local/x-ui/x-ui.sh
chmod +x /usr/bin/x-ui
# Setup database before configuration
database_setup
config_after_install
systemctl daemon-reload
systemctl enable x-ui
systemctl start x-ui
echo -e "${green}x-ui ${tag_version}${plain} installation finished, it is running now..."
echo -e ""
echo -e "┌───────────────────────────────────────────────────────┐"
echo -e "${blue}x-ui control menu usages (subcommands):${plain}"
echo -e "│ │"
echo -e "${blue}x-ui${plain} - Admin Management Script │"
echo -e "${blue}x-ui start${plain} - Start │"
echo -e "${blue}x-ui stop${plain} - Stop │"
echo -e "${blue}x-ui restart${plain} - Restart │"
echo -e "${blue}x-ui status${plain} - Current Status │"
echo -e "${blue}x-ui settings${plain} - Current Settings │"
echo -e "${blue}x-ui enable${plain} - Enable Autostart on OS Startup │"
echo -e "${blue}x-ui disable${plain} - Disable Autostart on OS Startup │"
echo -e "${blue}x-ui log${plain} - Check logs │"
echo -e "${blue}x-ui banlog${plain} - Check Fail2ban ban logs │"
echo -e "${blue}x-ui update${plain} - Update │"
echo -e "${blue}x-ui legacy${plain} - legacy version │"
echo -e "${blue}x-ui install${plain} - Install │"
echo -e "${blue}x-ui uninstall${plain} - Uninstall │"
echo -e "${blue}x-ui database${plain} - Database Management │"
echo -e "└───────────────────────────────────────────────────────┘"
}
echo -e "${green}Running...${plain}"
install_base
install_x-ui $1