# Configuration

> What each setting in plugins/Oasis/config.yml does.

Source: https://oasis-protection.com/docs/reference/config/

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.

## storage

### storage.engine

Default: `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?](/docs/guides/embedded-or-server/)

If you switch on a server that already has history, run `/oasis move` after the restart to bring that history along.

Accepts: `embedded` or `server`

Needs a restart

### storage.server

#### storage.server.address

Default: `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](/docs/packs-server/setup/#pterodactyl-and-pelican).

The `unix:` form only works when Minecraft runs as the same user as Packs Server, so most servers should use `host:port`.

Accepts: `host:port`, or `unix:<path>` for Packs Server's socket

Needs a restart

#### storage.server.store

Default: `survival`

The store you made with `packs store create`. Each Minecraft server needs a store of its own.

Accepts: the name of a store on Packs Server

Needs a restart

#### storage.server.key

Default: `""`

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.

Accepts: the private key that `packs key add` printed

Needs a restart

#### storage.server.server-key

Default: `""`

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.

Accepts: the server key that `packs key add` printed

Needs a restart

#### storage.server.outage-after

Default: `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.

Accepts: a length of time, like `5s` or `30s`

Needs a restart

## logging

### logging.ignored-worlds

Default: `[]`

Worlds where Oasis logs nothing at all, like `[creative, minigames]`.

Accepts: a list of world names

### logging.redacted-commands

Default: `[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.

Accepts: a list of command names, without the slash

### logging.events

#### logging.events.breaking

Default: `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`.

Accepts: `true` or `false`

#### logging.events.placing

Default: `true`

Players placing blocks.

Accepts: `true` or `false`

#### logging.events.explosion

Default: `true`

Blocks destroyed by TNT, creepers, beds and end crystals.

Accepts: `true` or `false`

#### logging.events.fire

Default: `true`

Fire burning blocks away.

Accepts: `true` or `false`

#### logging.events.ignition

Default: `true`

Fire lit by flint and steel, fire charges, lava or lightning.

Accepts: `true` or `false`

#### logging.events.flow

Default: `true`

Water and lava flowing.

Accepts: `true` or `false`

#### logging.events.melting

Default: `true`

Ice and snow melting, and coral dying.

Accepts: `true` or `false`

#### logging.events.forming

Default: `true`

Ice, snow and concrete forming.

Accepts: `true` or `false`

#### logging.events.spreading

Default: `true`

Fire, grass, mushrooms and vines spreading.

Accepts: `true` or `false`

#### logging.events.decay

Default: `true`

Leaves decaying.

Accepts: `true` or `false`

#### logging.events.growth

Default: `true`

Crops, saplings and trees growing.

Accepts: `true` or `false`

#### logging.events.piston

Default: `true`

Blocks pushed and pulled by pistons.

Accepts: `true` or `false`

#### logging.events.bucket

Default: `true`

Water and lava poured or scooped up with buckets, or poured by dispensers.

Accepts: `true` or `false`

#### logging.events.sign

Default: `true`

Text written on signs.

Accepts: `true` or `false`

#### logging.events.writing

Default: `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.

Accepts: `true` or `false`

#### logging.events.interaction

Default: `true`

Doors, gates, trapdoors, buttons and levers used. For lookups only.

Accepts: `true` or `false`

#### logging.events.worldedit

Default: `true`

WorldEdit and FAWE changes. Oasis logs FastAsyncWorldEdit, not plain WorldEdit.

Accepts: `true` or `false`

#### logging.events.killing

Default: `true`

Mobs and animals killed.

Accepts: `true` or `false`

#### logging.events.spawning

Default: `true`

Boats, minecarts and armor stands placed, and mobs from spawn eggs, breeding and splits.

Accepts: `true` or `false`

#### logging.events.hanging

Default: `true`

Paintings and item frames placed and broken.

Accepts: `true` or `false`

#### logging.events.framing

Default: `true`

Items put in, turned or taken out of item frames.

Accepts: `true` or `false`

#### logging.events.equipping

Default: `true`

Armor and items put on or taken off armor stands.

Accepts: `true` or `false`

#### logging.events.container

Default: `true`

Items moved in and out of chests and other containers.

Accepts: `true` or `false`

#### logging.events.dropping

Default: `true`

Items players drop.

Accepts: `true` or `false`

#### logging.events.pickup

Default: `true`

Items players pick up.

Accepts: `true` or `false`

#### logging.events.chat

Default: `true`

Chat messages. For lookups only.

Accepts: `true` or `false`

#### logging.events.command

Default: `true`

Commands players run. For lookups only. Arguments of the commands in `redacted-commands` are never stored.

Accepts: `true` or `false`

#### logging.events.login

Default: `true`

Players joining. For lookups only.

Accepts: `true` or `false`

#### logging.events.logout

Default: `true`

Players leaving. For lookups only.

Accepts: `true` or `false`

## rollback

### rollback.confirm-above

Default: `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.

Accepts: a number of changes

### rollback.turbo-above-chunks

Default: `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.

Accepts: a number of chunks

### rollback.target-tick-ms

Default: `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.

Accepts: a number of milliseconds

## updates

### updates.check

Default: `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](/docs/updating/#finding-out-about-updates) says more.

Accepts: `true` or `false`

## diagnostics

### diagnostics.console

Default: `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`](/docs/reference/commands/#sharing-the-cairn) 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.

Accepts: `true` or `false`
