Install single binary Proton

One line installer (TL;DR)

curl -sSf https://raw.githubusercontent.com/timeplus-io/proton/develop/install.sh | sh

HOWTO Steps

Please follow these steps to install a single binary Proton on your bare metal.

(Note: Installation is not a must. If you only wanna play proton, download binary and directly start the server. The data will be stored in the current path. no sudo requirement. simply proton server start and proton client in another terminal to connect. Use CTRL+C to terminate the server. Check out our docs for more fun).

1. Pick Proton version (latest version is recommended) and download the correct binary for your platform / OS from https://github.com/timeplus-io/proton/releases

2. Execute chmod +x <proton-binary> to make it executable if necessary. For example, chmod +x proton-macos-m2.

3. Run ./proton install --prefix <your root proton folder>. For example, in MacOS, if you like to just install everything on your local folder to try it out, run ./proton-macos-m2 install --prefix ./ and input password etc for the following prompts. In MacOS, you may need configure the security setting to let the Proton binary run. Please note also if you are installing Proton in system directory like /usr/bin/ etc, you may need run the command with sudo.

4. Run proton server --config etc/proton-server/config.yaml to start up the Proton server. If Proton is installed in local folder not in system bin folder like /usr/bin, we need specify the relative paths like ./usr/bin/proton server --config ./etc/proton-server/config.yaml.

5. Run proton client -u default --password <password> to connect the Proton server if you have setup password in step 3 above, otherwise you can just run proton client shall work. Continuing the local install example, user can run ./usr/bin/proton client -u default --password <password> if setting a password, otherwise run ./usr/bin/proton client