Known

# Idno: a social publishing platform

![Idno - A social publishing platform](https://withknown.com/img/home/screens.png)

## Installation 

Idno is under active development and requires PHP 8.3+ with selected extensions, together with a supported database backend. You can find detailed installation instructions here: <http://docs.idno.co/en/latest/install/index.html>

#### Installing from packages

_Unofficial_ install packages, which are periodically built from the latest code, are available: <https://www.marcus-povey.co.uk/known/>

#### Installing from Github

You can opt to check out the work-in-progress development code from the git repository: <https://github.com/idno/idno>

* Check out the repo: ```git clone https://github.com/idno/idno.git```
* Fetch dependencies: ```cd idno; composer install```

#### Installing with composer

You can install Idno directly from composer using: ``` composer create-project idno/idno ```

Optionally, you can install the latest bleeding edge code the same way: ``` composer create-project idno/idno -s dev ```

### Setting up the async pipeline

By default, Idno processes events **synchronously** — that is, things like
Webmention pings, syndication, and ActivityPub delivery all happen inside the
web request that triggered them. This works, but it makes page saves slow and
means a timeout or crash loses the work.

Enabling the **asynchronous queue** moves all of that into a background worker.
The web request just drops an event into the database and returns immediately;
the worker picks it up and processes it separately.

**This is required for ActivityPub.** Follow-accept delivery,
post distribution to followers, and update/delete propagation are all
dispatched through the queue. If the worker is not running, those events
sit in the database unprocessed and remote servers will never receive them.

#### 1. Enable the async queue

Add this line to your `config.ini`:

```ini
event_queue = 'AsynchronousQueue'
```

Without this line (or with the default `SynchronousQueue`), all events are
processed inline during the web request.

#### 2. Start the event queue worker

```bash
sudo -u www-data IDNO_DOMAIN='your.domain' ./idno.php service-event-queue
```

| Option       | Default   | Description                                |
|--------------|-----------|--------------------------------------------|
| `--queue`    | `default` | Named queue to process                     |
| `--interval` | `1`       | Seconds to sleep between polling cycles    |

**How it works:** The worker runs an infinite loop. Each cycle it:

1. Queries the database for up to 50 pending events.
2. Dispatches each one via an internal HTTP call to `/service/queue/dispatch/{id}`,
   which triggers the event handler (e.g., signing and POSTing an ActivityPub
   activity to a remote inbox).
3. Runs garbage collection to remove completed events older than 5 minutes.
4. Sleeps for `--interval` seconds, then repeats.

**If the worker dies, queued events pile up in the database but are not lost.**
They will be processed once the worker is restarted.

#### 3. Keep it alive with systemd (recommended)

The worker must stay running permanently. The simplest way is a systemd service
unit. Create `/etc/systemd/system/idno-queue.service`, taking care to replace the
values here with your own paths, users, and domains:

```ini
[Unit]
Description=Idno async event queue worker
After=network.target

[Service]
Type=simple
User=www-data
Environment=IDNO_DOMAIN=your.domain
WorkingDirectory=/var/www/idno
ExecStart=/var/www/idno/idno.php service-event-queue #replace with your path
Restart=always
RestartSec=5

[Install]
WantedBy=multi-user.target
```

Then enable and start it:

```bash
sudo systemctl daemon-reload
sudo systemctl enable --now idno-queue
```

Check status any time with:

```bash
sudo systemctl status idno-queue
sudo journalctl -u idno-queue -f   # tail the logs
```

#### Alternative: use cron instead of systemd

If you don't have access to systemd (e.g. shared hosting), you can use cron
instead. The `--once` flag makes the worker process one batch of pending events
and exit, which is ideal for cron:

```
* * * * * sudo -u www-data IDNO_DOMAIN='your.domain' /var/www/idno/idno.php service-event-queue --once >> /var/log/idno-queue.log 2>&1
```

This processes pending events once per minute. Events may take up to 60 seconds
to be delivered (compared to ~1 second with the systemd worker above).

#### 4. Run the periodic cron service (optional)

If you need periodic background tasks (triggered via `cron/minute`,
`cron/hourly`, and `cron/daily` events), start the cron service the same way:

```bash
sudo -u www-data IDNO_DOMAIN='your.domain' ./idno.php service-cron
```

You can create a second systemd unit (`idno-cron.service`) following the same
pattern as above if you want it managed automatically.

#### 5. After updates — restart the workers

When you update Idno core or any plugins, **restart both services** so they
pick up the new code:

```bash
sudo systemctl restart idno-queue idno-cron
```

### Support us

* [Star us on GitHub](https://github.com/idno/idno)
* [Like us on alternativeto.net](http://alternativeto.net/software/known/)
* [Contribute](CONTRIBUTING.md)

### Get support

* Try the open source mailing list: <https://groups.google.com/forum/#!forum/known-dev>

## Community links

* Learn more and sign up to get updates: <https://idno.co>
* Full project documentation: <http://docs.idno.co/>

For details on contributing to the Idno project, please read [CONTRIBUTING.md](CONTRIBUTING.md).

## Contributors

This project exists thanks to all the people who contribute. [[Contribute](CONTRIBUTING.md)].

See [contributors on GitHub](https://github.com/idno/idno/graphs/contributors).

## Copyright and License

Except for included third-party projects, Idno is (c) The Open Community Company LLC.

Unless otherwise stated, Idno is licensed under the Apache Software License 2.0. See [LICENSE](LICENSE) for more information.

Idno logos are (c) Idno, Inc. Permission from Idno, Inc is required to use the Idno name or logo as part of any
project, product, service, domain or company name, except as included in official themes distributed by Idno.

Logos of external services are (c) their respective owners. All rights reserved.

Third party libraries are licensed separately.

### Idno also contains

* Bootstrap, which is distributed under the Apache 2.0 license. Source: https://github.com/twitter/bootstrap
* jQuery, which is distributed under the MIT License. Source: https://github.com/jquery/jquery
* Portions of Symfony, which is distributed under the MIT license.
  * EventDispatcher. Source: https://github.com/symfony/EventDispatcher
  * HttpFoundation. Source: https://github.com/symfony/HttpFoundation
  * Console. Source: https://github.com/symfony/console
* ToroPHP, which is distributed under the MIT License. Source: https://github.com/anandkunal/ToroPHP/
* Fork Awesome, which is distributed under the Open Font License, version 1.1: https://github.com/ForkAwesome/Fork-Awesome
* Steve Clay's AutoP, which is distributed under the MIT License. Source: https://code.google.com/p/mrclay/
* Aaron Parecki's Webmention Client, which is distributed under the Apache 2.0 license. Source: https://github.com/aaronpk/mention-client
* Barnaby Walters's Microformats 2 Parser, which is distributed under the MIT License. Source: https://github.com/indieweb/php-mf2
* FitVids.js, which is distributed under the WTFPL License. Source: http://fitvidsjs.com/
* Leaflet.js, which is distributed under the BSD 2-Clause License. Source: http://leafletjs.com/ 
* SwiftMailer, which is distributed under the MIT License. Source: https://github.com/swiftmailer/swiftmailer
* Antwort, an email template which is distributed under the MIT License. Source: https://github.com/internations/antwort
* Mention.js, a Bootstrap user at-mention library, which is distributed under the MIT License. Source: https://github.com/jakiestfu/Mention.js
* MediaElement.js, a cross-browser media player, which is distributed under the MIT License. Source: https://github.com/johndyer/mediaelement
* Simplepie, a feed parser, which is distributed under the BSD 3-Clause License. Source: https://github.com/simplepie/simplepie/
* Bootstrap Toggle, which is distributed under the MIT License. Source: http://www.bootstraptoggle.com/
* TinyMCE, a rich text editor, which is distributed under the LGPL License. Source: https://github.com/tinymce/tinymce
* The Paypal Bootstrap Accessibility Plugin, which is distributed under the BSD 3-Clause License. Source: https://github.com/paypal/bootstrap-accessibility-plugin
* HTMLPurifier, which is distributed under the LGPL License. Source: http://htmlpurifier.org
* Wavesurfer, which is distrubuted under a Creative Commons Attribution 3.0 Unported License. Source: https://github.com/katspaugh/wavesurfer.js
* MongoDB-PHP-Library, which is distributed under the Apache 2 Licence. Source: https://github.com/mongodb/mongo-php-library
* Exif-js, which is distributed under the MIT Licence. Source: https://github.com/exif-js/exif-js
* PHP-OGP, distributed under the GPL2 Licence. Source: https://github.com/mapkyca/php-ogp

## Thank you

[<img src="https://user-images.githubusercontent.com/624104/52508260-d0daa180-2ba8-11e9-970c-3ef9596f6b4e.png" alt="BrowserStack Logo" width="120">](https://www.browserstack.com/)

Thanks to [BrowserStack](https://www.browserstack.com/) for providing the infrastructure that allows us to test in real browsers.