Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions astro.config.mjs
Original file line number Diff line number Diff line change
Expand Up @@ -160,6 +160,7 @@ export default defineConfig({
items: [
{ label: "Installation", link: "v5/getting-started/installation/"},
{ label: "NixOS", link: "v5/getting-started/nixos/"},
{ label: "Running Noctalia", link: "v5/getting-started/running-the-shell/"},
{
label: "Compositor Settings",
items: [
Expand Down
30 changes: 30 additions & 0 deletions src/content/docs/v5/getting-started/running-the-shell.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,30 @@
---
title: Running Noctalia
description: This page gives you a basic example on how to run the shell.
sidebar:
order: 30
---

:::tip[Method]
Use compositor autostart as the primary method.
:::
### Autostart by your Wayland compositor
This is the recommended method for launching noctalia, as it integrates with your window manager.

For the *Niri* compositor, add the following line to the end of your configuration file, typically located at `~/.config/niri/config.kdl`
```ini
spawn-at-startup "noctalia"
```

For the *Hyprland* compositor, append this line to your configuration file, typically located at `~/.config/hypr/hyprland.conf`
```ini
exec-once = noctalia
```

---

### Manual Launch for Debugging
The most direct way to run Noctalia for testing or debugging. Open a terminal and execute:
```bash
noctalia
```
Loading