Configuration
Oasis creates plugins/Oasis/config.yml the first time it starts. Out of the box it logs everything and keeps the history on your own server, so you don’t have to change anything to get going.
Below is the whole file with its default values. Click any setting to see what it does and what it accepts.
After you edit the file, run /oasis reload. Settings marked Needs a restart are read only when the server starts, so restart the server for those.
engine: embedded#
Where your history lives. embedded keeps it inside your server, in plugins/Oasis/store. server sends it to Packs Server instead. If you're not sure which you want, stay on embedded and read Embedded or Packs Server?
If you switch on a server that already has history, run /oasis move after the restart to bring that history along.
Needs a restart
address: 127.0.0.1:7650#
Where Packs Server listens. The default is right when Packs Server runs on the same machine as Minecraft and outside a panel. If you use Pterodactyl or Pelican, see Set up Packs Server.
The unix: form only works when Minecraft runs as the same user as Packs Server, so most servers should use host:port.
Needs a restart
store: survival#
The store you made with packs store create. Each Minecraft server needs a store of its own.
Needs a restart
key: ""#
The key Oasis uses to log in to Packs Server. Packs Server shows it only once, when you run packs key add. If you lose it, make a new one with packs key add and a new name.
Needs a restart
server-key: ""#
Packs Server's own key. Oasis refuses to talk to any Packs Server that can't prove it holds this key, so nobody can pose as your Packs Server.
Needs a restart
outage-after: 5s#
How long Packs Server can stay silent before Oasis treats it as down. While it's down, Oasis keeps logging into plugins/Oasis/outbox and sends everything over once Packs Server is back, so nothing is lost.
Needs a restart
ignored-worlds: []#
Worlds where Oasis logs nothing at all, like [creative, minigames].
redacted-commands: [login, l, register, reg, changepassword, changepass, cp, unregister]#
Keeps passwords out of your history. Oasis still logs that someone ran the command, but it writes <redacted> in place of everything after it.
Write each command without the slash and without a plugin name: login also covers /authme:login. If your login plugin uses other commands, add them here.
breaking: true#
Blocks, armor stands, boats, and minecarts broken. Like every event, this name is also a word you can use after cause in a command, like /lookup cause breaking.
placing: true#
Players placing blocks.
explosion: true#
Blocks destroyed by TNT, creepers, beds and end crystals.
fire: true#
Fire burning blocks away.
ignition: true#
Fire lit by flint and steel, fire charges, lava or lightning.
flow: true#
Water and lava flowing.
melting: true#
Ice and snow melting, and coral dying.
forming: true#
Ice, snow and concrete forming.
spreading: true#
Fire, grass, mushrooms and vines spreading.
decay: true#
Leaves decaying.
growth: true#
Crops, saplings and trees growing.
piston: true#
Blocks pushed and pulled by pistons.
bucket: true#
Water and lava poured or scooped up with buckets, or poured by dispensers.
sign: true#
Text written on signs.
writing: true#
Books written and signed, with their pages. This one is for lookups only: you can search it, but a rollback never touches it, since there's nothing in the world to put back.
interaction: true#
Doors, gates, trapdoors, buttons and levers used. For lookups only.
worldedit: true#
WorldEdit and FAWE changes. Oasis logs FastAsyncWorldEdit, not plain WorldEdit.
killing: true#
Mobs and animals killed.
spawning: true#
Boats, minecarts and armor stands placed, and mobs from spawn eggs, breeding and splits.
hanging: true#
Paintings and item frames placed and broken.
framing: true#
Items put in, turned or taken out of item frames.
equipping: true#
Armor and items put on or taken off armor stands.
container: true#
Items moved in and out of chests and other containers.
dropping: true#
Items players drop.
pickup: true#
Items players pick up.
chat: true#
Chat messages. For lookups only.
command: true#
Commands players run. For lookups only. Arguments of the commands in redacted-commands are never stored.
login: true#
Players joining. For lookups only.
logout: true#
Players leaving. For lookups only.
confirm-above: 100000000#
How many changes a rollback or restore can touch before Oasis asks you to confirm it. The default is 100 million, so in practice only enormous rollbacks ask.
turbo-above-chunks: 2000#
Only matters with Packs Server. A rollback or restore that covers more chunks than this offers the Confirm with turbo button. Turbo moves the players out of the affected area before the operation starts. This setting counts chunks, not changes. Raise it to offer turbo less often.
target-tick-ms: 45#
The tick length Oasis protects while a rollback runs. Oasis places blocks with whatever time the tick has left, and it stops at this mark no matter what. A Minecraft tick is 50 ms, so the default of 45 leaves a little room to spare. Lower it if you'd rather have rollbacks take longer and the server feel smoother while they run.
check: true#
Whether Oasis looks for a newer build. It looks when the server starts and every six hours after that, and names a newer build in the console and in /oasis status. A dev build tells you about the newest build, and a release only about newer releases. Oasis never downloads or installs an update by itself. Updating says more.
console: false#
Oasis always records what each rollback, restore, undo, recovery, and lookup did and how long each step took, a few of the blocks each one met with their history, and the health of the server and the store each minute, in plugins/Oasis/cairn: every record for 90 days in days, in at most 512 MB. Starts, errors, outages, and failed operations also stay 12 months in year, in at most 64 MB. Nothing leaves the server unless you run /cairn share when the Oasis team asks for it in a GitHub issue. Set this to true to also print the one-line summaries of the records in the console.