Skip to content
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

docs(readme): add architecture diagram #1995

Merged
merged 2 commits into from
May 17, 2024
Merged

docs(readme): add architecture diagram #1995

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e27f7aa
docs(readme): add architecture diagram, with open questions
cfm May 8, 2024
a804886
Apply suggestions from code review
cfm May 9, 2024
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
33 changes: 32 additions & 1 deletion log/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,42 @@ Workstation](https://github.com/freedomofpress/securedrop-workstation) project.

This is a Python module and qrexec service for logging in Qubes.

#### Quick Start
## Quick Start

1. [Install Poetry](https://python-poetry.org/docs/#installing-with-the-official-installer)
2. Run `make test` to verify the installation

## Architecture

```mermaid
graph TD

subgraph "sink VM (e.g., sd-log)"
subgraph systemd
redis.service --before--- securedrop-log.service
end
subgraph qrexec
securedrop.Log
end

redis.service --> Redis((Redis))
securedrop.Log>securedrop.Log] --> securedrop-redis-log --"writes to"--> Redis
Redis -.blocking read-loop.-> securedrop-log-saver
securedrop-log.service --> securedrop-log-saver --> QubesIncomingLogs/
end

subgraph "source VM (e.g., sd-app)"
subgraph rsyslog
sd-rsyslog --activated by--- /etc/rsyslog.d/sdlog.conf
sd-rsyslog --configured by--- /etc/sd-rsyslog.conf
sd-rsyslog -.qrexec.-> securedrop.Log
end
end

securedrop-log???
securedrop_log??? -.qrexec.-> securedrop.Log
```

## How to use/try this?

In our example, we will use a vm named *logging* for storing logs, and we will use
Expand Down