1. Overview
   
2. Concepts
   
3. Access
   
4. Usage
   
5. Design
   
6. Additional Information
   

Awakari is an events filter. The purpose is to allow users to follow their interests instead of subjective sources.

As a publish/subscribe service it works with events and interest subscriptions. Awakari performs a continuous prospective search capturing relevant events in the events stream on the fly.

A condition represents a message matching criteria. Currently, Awakari supports the following condition types:

• text matching
• numeric comparison (<, ≤, =, ≥, >)
• groups of nested condtions with logic (And, Or, Xor)

Any condition may be negative ("Not"). The matching is structured by design: text and numeric conditions may be used to match a certain attribute of an event.

Interest is a set of matching conditions associated with a specific user. Internally interest is named subscription.

The entity being routed and delivered by Awakari. The accepted format is Cloud Events. There are multiple source integrations, producing events from:

• Web feeds (like RSS)
• Fediverse publishers
• Telegram channels

Using the Awakari cloud API requires mutual TLS authentication and encryption to secure all client data. Hence, to access the cloud API it's necessary to have a client certificate.

Prepare own client certificate request:

openssl req -new -newkey rsa:4096 -nodes \
  -keyout client.key \
  -out client.csr \
  -addext "subjectAltName=DNS:api.awakari.com" \
  -subj '/CN=group0.company1.com'

Warning Never specify additional certificate attributes like "O", "OU", etc. The resulting DN should not contain commas.

Then request the client certificate (currently by email).

TODO

• Opt-Out Methods
• Roadmap
• Contributing