Oxelone Docs

Search docs and API

Find a guide, a section of one, or an API operation by its name.

Open console (opens in a new tab)

Administration General

General

General holds what identifies your workspace: its name, its logo, its slug and its ID. The name and logo appear at the head of the console's sidebar.

Who can do it

Every member can read General. Changing anything needs Manage workspace settings (settings:manage), which only the Owner role holds. Everyone else sees the line "You need permission to manage settings." beside a disabled Save.

  1. Open Settings › Workspace › General.
  2. Edit Workspace name, or choose Choose file under Logo (Replace once a logo is set).
  3. Choose Save.

Every setting

SettingWhat it doesDefault
Workspace nameThe name shown in the sidebar and in the workspace switcher. Up to 80 characters.Set when the workspace was created
LogoA square PNG, JPEG or WebP, up to 256 KB. The server drops the file's metadata and stores a 256 px PNG. SVG is not accepted. A Sidebar preview shows it in both themes.No logo
SlugThe workspace's short name. It is permanent.Set when the workspace was created
Workspace IDThe workspace's identifier. Use Copy workspace ID to copy it.Set when the workspace was created

When it goes wrong

  • Workspace name must be 1 to 80 characters. The name is blank or longer than 80 characters.
  • Use a PNG, JPEG or WebP image. SVG is not accepted. Convert the image first.
  • The image is over 256 KB. Use a smaller one. Export it smaller.
  • Changing workspace settings requires settings:manage in this workspace. You are not an Owner. Ask one.

With the API

Not available with an API key. See API keys for what a key can reach.