Skip to content

docs: improve README #29

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
webbrain-one wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs: improve README #29

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 7 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@


# Home Assistant CUPS Print Server App

[![Version](https://img.shields.io/badge/version-1.0.0-blue.svg)](https://github.com/arest/cups-addon)
Expand Down Expand Up @@ -134,16 +136,15 @@ This project is licensed under the MIT License.

## Data Persistence

This app stores all CUPS data in the Home Assistant `/data` directory, ensuring:
This app stores all CUPS data in the Home Assistant `/share` directory, ensuring:

- Printer configurations persist across app restarts
- Print jobs and settings are maintained through system reboots
- App updates won't cause loss of printer configurations
- All CUPS data is included in Home Assistant backups

The following directories are maintained in the persistent storage:
- `/data/cups/config`: CUPS configuration files
- `/data/cups/cache`: CUPS cache data
- `/data/cups/logs`: CUPS log files
- `/data/cups/state`: CUPS state information

- `/share/cups/config`: CUPS configuration files
- `/share/cups/cache`: CUPS cache data
- `/share/cups/logs`: CUPS log files
- `/share/cups/state`: CUPS state information