This repository has been archived on 2021-12-15. You can view files and clone it, but cannot push or open issues or pull requests.
pubspace/README.md

52 lines
2.1 KiB
Markdown
Raw Normal View History

2021-06-15 11:35:51 +00:00
# pubspace
2021-06-16 09:24:08 +00:00
[![Build Status](https://drone.autonomic.zone/api/badges/ruangrupa/pubspace/status.svg?ref=refs/heads/main)](https://drone.autonomic.zone/ruangrupa/pubspace)
2021-06-15 11:35:51 +00:00
A service to facilitate collective digital publishing practices.
2021-06-15 12:00:19 +00:00
2021-06-16 11:32:08 +00:00
## How does publishing happen?
2021-06-15 12:00:19 +00:00
2021-06-16 11:32:08 +00:00
### cloud.lumbung.space
2021-06-15 12:00:19 +00:00
2021-06-16 11:32:08 +00:00
> **WARNING**: Only file sharing is implemented
2021-06-15 12:00:19 +00:00
2021-06-16 11:32:08 +00:00
- When a file is tagged with the `publish` tag, a share link will be generated
- This share link will be shown on the `publish.lumbung.space` prototype page
2021-06-15 12:00:19 +00:00
2021-06-16 11:32:08 +00:00
### social.lumbung.space
2021-06-15 12:00:19 +00:00
2021-06-16 11:32:08 +00:00
- When a toot uses the hashtag `#pubspace` (a comment on a thread will also "unroll" the entire thread)
- Only toots with `visibility: public` will be published. Local only posts and otherwise private posts are respected.
- This toot link will be shown on the `publish.lumbung.space` prototype page
### tv.lumbung.space
- When someone comments on a published video using the `#pubspace` hashtag
- This toot link will be shown on the `publish.lumbung.space` prototype page
## Supported services
- [cloud.lumbung.space](https://cloud.lumbung.space/) ([Nextcloud](https://nextcloud.com/))
- [tv.lumbung.space](https://tv.lumbung.space/) ([Peertube](https://joinpeertube.org/))
- [social.lumbung.space](https://social.lumbung.space/) ([Hometown](https://github.com/hometown-fork/hometown))
2021-06-16 09:17:32 +00:00
## Nextcloud flow script
2021-06-16 11:32:08 +00:00
See the [pubspace.sh](./pubspace.sh) script. This is manually copied over into
`/var/www/html/pubspace/pubspace.sh` for now. There is a workflow scripts rule
configured that when a file is tagged, the script is run. The script sends the filename
to this service and then we use the [pyocclient](https://github.com/owncloud/pyocclient)
to generate a share for that file. The Nextcloud crontab runs the script.
2021-06-16 09:17:32 +00:00
## Deployment
> Work In Progress
```
$ printf $YOURMASTODONACCESSTOKEN | docker secret create publish_lumbung_space_access_token_v1 -
2021-06-16 13:26:04 +00:00
$ printf $YOURNEXTCLOUDAPPPASSWORD | docker secret create publish_lumbung_space_app_password_v1 -
2021-06-16 09:17:32 +00:00
$ cp .env.sample .env # and update the values to match the environment
$ set -a && source .env && set +a
$ docker stack deploy -c compose.yml publish_lumbung_space
```