Metadata-Version: 2.1
Name: rbinstall
Version: 1.1.1
Summary: Official installer for Review Board code/document review.
Author-email: "Beanbag, Inc." <questions@beanbaginc.com>
License: Copyright (c) 2023  Beanbag, Inc.
        
        Permission is hereby granted, free of charge, to any person obtaining a copy of
        this software and associated documentation files (the "Software"), to deal in
        the Software without restriction, including without limitation the rights to
        use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
        of the Software, and to permit persons to whom the Software is furnished to do
        so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: homepage, https://github.com/reviewboard/rbinstall
Project-URL: documentation, https://github.com/reviewboard/rbinstall
Project-URL: repository, https://github.com/reviewboard/rbinstall
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: System Administrators
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: MacOS
Classifier: Operating System :: MacOS :: MacOS X
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: System
Classifier: Topic :: System :: Installation/Setup
Classifier: Topic :: System :: Software Distribution
Classifier: Topic :: System :: Systems Administration
Requires-Python: >=3.7
Description-Content-Type: text/markdown
License-File: COPYING
License-File: AUTHORS
Requires-Dist: packaging~=23.2
Requires-Dist: rich~=13.7.0
Requires-Dist: typing_extensions>=4.3.0
Requires-Dist: virtualenv

Review Board Installer
======================

The Review Board Installer, rbinstall, is designed to simplify installing
[Review Board](https://www.reviewboard.org/) on a wide variety of Linux
distributions.

Installation can be performed with a single command:

```shell
$ curl https://install.reviewboard.org | python3
```

Alternatively, you can run:

```shell
$ pipx run rbinstall
```

The installer must be run as `root`.


Compatibility
-------------

rbinstall requires a supported Linux or macOS system with Python 3.7 or higher.

**NOTE:** If you're using a non-default version of Python, you will need to use
a web server such as [gunicorn](https://gunicorn.org/),
[uwsgi](https://uwsgi-docs.readthedocs.io/en/latest/), or build an Apache
`mod_wsgi` for your server using
[mod_wsgi-express](https://pypi.org/project/mod-wsgi/).


### Linux Compatibility

The following Linux distributions are directly supported on a default install:

* Amazon Linux 2023
* Arch Linux
* CentOS 9 Stream
* Debian 11 (Buster)
* Debian 12 (Bullseye)
* Debian 13 (Bookworm)
* Fedora 36
* Fedora 37
* Fedora 39
* Fedora 39
* Fedora 40
* openSUSE Tumbleweed
* Red Hat Enterprise Linux 9
* Rocky Linux 9
* Ubuntu 20.04
* Ubuntu 22.04
* Ubuntu 23.10


The following are known to work if you install a newer version of Python
(see below):

* Amazon Linux 2
* openSUSE Leap 15
* Red Hat Enterprise Linux 8
* Rocky Linux 8
* Ubuntu 18.04


### macOS Compatibility

The following versions of macOS have been tested:

* macOS Ventura
* macOS Sonoma

[Homebrew](https://brew.sh) is currently required for installation on macOS.


Legacy Distro Notes
-------------------

### Amazon Linux 2

Before installing on Amazon Linux 2, you will need to install a newer version
of Python:

```shell
sudo amazon-linux-extras install python3.8
sudo yum install python38-devel
```

Then run the installation script with `python3.8`.

Please note that Python 3.8 reaches end-of-life on October 14, 2024. Versions
of Review Board after this date may no longer support Python 3.8.


### openSUSE Leap 15

Before installing on openSUSE Leap 15, you will need to install a newer version
of Python:

```shell
sudo zypper install python39 python39-devel
```

Then run the installation script with `python3.9`.


### Red Hat Enterprise Linux 8

Before installing on Red Hat Enterprise Linux 8, you will need to install a newer version
of Python:

```shell
sudo yum install -y python38 python38-devel
```

Then run the installation script with `python3.8`.

Note that due to missing packages, Single Sign-On is not available on
Red Hat Enterprise Linux 8.

Please note that Python 3.8 reaches end-of-life on October 14, 2024. Versions
of Review Board after this date may no longer support Python 3.8.


### Rocky Linux 8

Before installing on Rocky Linux 8, you will need to install a newer version
of Python:

```shell
sudo dnf module install python38
sudo dnf install python38-devel
```

Then run the installation script with `python3.8`.

Note that due to missing packages, Single Sign-On is not available on
Rocky Linux 8.

Please note that Python 3.8 reaches end-of-life on October 14, 2024. Versions
of Review Board after this date may no longer support Python 3.8.


### Ubuntu 18.04

Before installing on Ubuntu 18.04, you will need to install a newer version
of Python:

```shell
sudo apt-get install software-properties-common
sudo add-apt-repository ppa:deadsnakes/ppa
sudo apt-get install python3.8 python3.8-dev python3.8-venv
```

Then run the installation script with `python3.8`.

Note that due to missing packages, Single Sign-On is not available on
Ubuntu 18.04.

Please note that Python 3.8 reaches end-of-life on October 14, 2024. Versions
of Review Board after this date may no longer support Python 3.8.
