Skip to main content

Server News

You can keep your users informed by adding a news.md file. Use it to link your game wishlist form, share key updates, or simply greet them.

This file supports Markdown syntax, making it easy to format and structure your content. You can edit the news.md file using any text editor or script. It is located at /config/news.md. If you're using Docker, simply mount that folder as a volume:

note

When updating the news.md file., users will receive a notification ping-icon in their client, ensuring they see the latest news.

[...]
volumes:
    - /your/config/folder:/config
    - [...]
[...]

Managing News via API​

Starting with v16.3.0, administrators can update server news directly via API. Only users with the Admin role can update news. The server must be able to write to your config volume (VOLUMES_CONFIG).

Editing News in the Client​

Starting with v17.0.0, the GameVault client includes a built-in News Editor for administrators. Open the News dialog (newspaper icon in the sidebar) and switch to the Server News tab: admins see an Edit button that opens a Markdown editor with a preview. Changes are saved back to the server's news.md file via the API, so you no longer need to edit the file manually. Only users with the Admin role can edit server news.