https://github.com/theduke/panorama

System status notification daemon for Linux desktop environments.
https://github.com/theduke/panorama

desktop-environment i3 linux sway wayland

Last synced: about 1 month ago
JSON representation

System status notification daemon for Linux desktop environments.

• Host: GitHub
• URL: https://github.com/theduke/panorama
• Owner: theduke
• Created: 2023-10-20T23:26:38.000Z (about 1 year ago)
• Default Branch: main
• Last Pushed: 2023-10-30T17:55:05.000Z (about 1 year ago)
• Last Synced: 2024-04-16T06:59:32.547Z (7 months ago)
• Topics: desktop-environment, i3, linux, sway, wayland
• Language: Rust
• Homepage:
• Size: 69.3 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 9
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# panorama

A system status notification daemon for Linux systems.

Panorama will send notifications for various system events, and is primarily

useful for bare-bones desktop environments like i3 or sway.

## Features

- [x] Battery status notifications

- [x] Internet offline/online notifications

- [ ] High disk usage warnings

- [ ] disk mount/unmount notifications

- [ ] USB device attach/detach notifications

## Installation

### Nix(OS)

If you use nix or NixOS, panorama can easily be run through the official flake:

```

nix run github.com/theduke/panorama

```

To install, you can use the flake as a dependency in your own system flake.nix.

**Note**: panorama will hopefully be upstreamed into nixpkgs soon.

### Build & install from source

If you have Rust installed, you can install easily install panorama from source:

**NOTE**: You must have the libudeps library installed, and it's headers available!

* Ubuntu: `apt-get install -y libudeps-dev`

* ...

```

git clone https://github.com/theduke/panorama

cd panorama

cargo install --path .

```

## Usage

Just run the `panorama` command.

This will start the daemon.

## Configuration

Panorama can be heavily customized through the configuration file.

The default config file path is `$HOME/.config/panorama/config.toml`, and can

be customized with `-c/--config `.

To generate a default config, use `panorama --dump-default-config`.

You can inspect the default file to get information about all the options.

The default config is also available online: [config.yaml](./config.yaml).