Installation
One command on Linux and macOS, or two files copied by hand anywhere else.
Altay needs two things: the server phar and a PHP binary built with the extensions the server expects.
Distribution PHP will not work
A PHP from apt, dnf, brew or php.net is missing extensions Altay depends on and is built without the threading support the server needs. Use the project's own builds.
The installer
Run it
curl -sL https://getaltay.org/download | bash -s -It picks the newest release, works out which PHP build matches your platform and architecture,
downloads both, fixes the extension paths and timezone in php.ini, and writes a start.sh. If no
prebuilt PHP fits your machine, it compiles PHP from source instead of failing.
Start the server
./start.shThe first run writes the configuration, generates the default world and drops you at the console. See First run.
Options
Options go after -s -:
curl -sL https://getaltay.org/download | bash -s - -d server| Option | Effect |
|---|---|
-d PATH | Install into a directory instead of the current one. |
-v nightly | Use the nightly channel instead of the stable release. |
-u | Update the server only and keep the PHP build you already have. |
-c | Compile PHP from source even if a prebuilt binary exists. |
-r | Allow running as root. Do not do this without a reason. |
-t URL | Install a specific phar from a URL. |
Requirements: a 64-bit system, bash, curl or wget, and tar (unzip on Windows).
Reading it before you run it
Piping a script from the internet into a shell is a decision, not a default. If you would rather look at it first:
wget https://getaltay.org/download
less download
bash downloadThe script is get-altay by maxencelobry, MIT licensed,
and it only downloads from the altayofficial GitHub organisation.
Installing by hand
Works everywhere, including Windows without bash.
Get the server
Download Altay.phar from the
latest release.
Get a PHP build
Download the recommended build for your platform from PHP-Binaries and extract it next to the phar.
Start it
./bin/php7/bin/php Altay.pharDocker
The repository ships a Dockerfile, so you can build an image from a checkout:
git clone https://github.com/altayofficial/Altay.git
cd Altay
docker build -t altay .
docker run -it -p 19132:19132/udp -v "$(pwd)/data:/data" altayKeep /data on a volume. Without it, your worlds and player data disappear with the container.
Nightly builds
Nightly builds come from the newest commit on master. Useful when a fix you need has landed but
has not been released yet. Not meant for a server people actually play on: no release notes, no
guarantee the build even starts.
curl -sL https://getaltay.org/download | bash -s - -v nightlyUpdating
Stop the server, replace Altay.phar, start it again. Worlds, players and plugins stay untouched.
curl -sL https://getaltay.org/download | bash -s - -uRead the release notes first
Each release names the Bedrock version it targets, and some releases drop support for an older client. The changelogs carry the detail. Plugins are the usual source of breakage after an update: check the plugin's repository before assuming the server is at fault.