[skip-ci] Update installation documentation for ProxySQL 3.0.3#5264
[skip-ci] Update installation documentation for ProxySQL 3.0.3#5264renecannao merged 2 commits intov3.0from
Conversation
This commit updates the installation documentation to reflect the current
ProxySQL 3.0.3 release and modern build dependencies.
Changes made:
1. README.md:
- Updated version references from 2.4.2 to 3.0.3
- Updated package download examples from ubuntu20 to ubuntu24
- Updated repository URLs from proxysql-2.4.x to proxysql-3.0.x
- Updated version check examples to show correct version format
- Fixed upgrade instructions to use current version
2. INSTALL.md (complete rewrite):
- Updated supported OS list to current distributions:
- AlmaLinux 8,9,10
- CentOS Stream 9,10
- Debian 12,13
- Fedora 40,41,42
- OpenSUSE Leap 15,16
- Ubuntu 22.04,24.04
- Updated repository configuration instructions for 3.0.x
- Updated docker build example to use v3.0.3 and ubuntu24 target
- Completely rewritten build dependency sections based on actual
Dockerfiles from ProxySQL/docker-images repository:
- Debian/Ubuntu: Added libmysqlclient-dev, libunwind, libicu-dev,
libevent-dev, libtirpc-dev
- RHEL/CentOS/AlmaLinux: Added epel-release, crb repo, libtirpc-devel,
rpcgen, and all required dev packages
- Fedora: Updated to current package names
- OpenSUSE: Added equivalent packages
- macOS: Updated Homebrew command
- Removed outdated "shortcut commands" that were incorrect
- Added direct links to docker-images repository for reference
The documentation now accurately reflects how to install and build
ProxySQL 3.0.3 on modern operating systems.
Summary of ChangesHello @renecannao, I'm Gemini Code Assist1! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed! This pull request focuses on a comprehensive update of the ProxySQL installation documentation. The primary goal is to align the documentation with the recently released ProxySQL 3.0.3, ensuring that users have accurate and up-to-date instructions for installing and building the software across a wide range of modern operating systems. This includes updating version numbers, repository paths, supported OS lists, and detailed build prerequisites. Highlights
🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console. Using Gemini Code AssistThe full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips. Invoking Gemini You can request assistance from Gemini at any point by creating a comment using either
Customization To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a Limitations & Feedback Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here. You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension. Footnotes
|
There was a problem hiding this comment.
Code Review
This pull request provides a comprehensive update to the installation documentation for ProxySQL 3.0.3. The changes in README.md and INSTALL.md are very valuable, with updated version numbers, repository URLs, supported OS lists, and much more detailed and accurate instructions for installing dependencies and configuring repositories. The rewrite of the build dependency sections is a significant improvement. I've found a few minor inconsistencies in the documentation that could be improved, and I've detailed them in my comments.
INSTALL.md
Outdated
| #### Red Hat / CentOS / AlmaLinux: | ||
| ```bash | ||
| cat > /etc/yum.repos.d/proxysql.repo << EOF | ||
| [proxysql] | ||
| name=ProxySQL YUM repository | ||
| baseurl=https://repo.proxysql.com/ProxySQL/proxysql-3.0.x/centos/\$releasever | ||
| gpgcheck=1 | ||
| gpgkey=https://repo.proxysql.com/ProxySQL/proxysql-3.0.x/repo_pub_key | ||
| EOF | ||
| ``` |
There was a problem hiding this comment.
The repository configuration for "Red Hat / CentOS / AlmaLinux" seems to use a URL specific to CentOS (the /centos/ path). This is likely incorrect for AlmaLinux, which requires /almalinux/ in the path as shown in README.md. This could cause installation failures for users on AlmaLinux. Please consider splitting this into separate sections for Red Hat/CentOS and AlmaLinux for clarity and correctness.
| #### Amazon Linux: | ||
| ```bash | ||
| cat > /etc/yum.repos.d/proxysql.repo << EOF | ||
| [proxysql] | ||
| name=ProxySQL YUM repository | ||
| baseurl=https://repo.proxysql.com/ProxySQL/proxysql-3.0.x/centos/8 | ||
| gpgcheck=1 | ||
| gpgkey=https://repo.proxysql.com/ProxySQL/proxysql-3.0.x/repo_pub_key | ||
| EOF | ||
| ``` |
There was a problem hiding this comment.
This section adds installation instructions for Amazon Linux, but Amazon Linux is not included in the list of supported operating systems at the top of this file (lines 14-29). To avoid confusion, please add Amazon Linux to the supported OS list if it is indeed supported.
INSTALL.md
Outdated
| # RHEL/CentOS/AlmaLinux/Fedora/Amazon Linux | ||
| yum install proxysql |
There was a problem hiding this comment.
The installation command for Fedora is given as yum install proxysql. While yum may work as an alias, dnf has been the default package manager in Fedora for several years. For consistency with modern Fedora and with the dependency installation command on line 165 (which correctly uses dnf), it would be better to use dnf and separate the Fedora instruction.
| # RHEL/CentOS/AlmaLinux/Fedora/Amazon Linux | |
| yum install proxysql | |
| # RHEL/CentOS/AlmaLinux/Amazon Linux: yum install proxysql | |
| # Fedora: dnf install proxysql |
- Split Red Hat/CentOS and AlmaLinux repository sections - Add Amazon Linux 2 to supported OS list - Use dnf for Fedora installation command These changes address the issues identified in the code review: 1. AlmaLinux now uses correct /almalinux/ repository path 2. Amazon Linux added to supported OS list for consistency 3. Fedora installation uses dnf instead of yum All repository configurations now match those in README.md.
|
|
I've addressed all review comments:
All changes have been pushed to the branch. |
Summary
Test Plan
The documentation now accurately reflects how to install and build ProxySQL 3.0.3 on modern operating systems.