lumbung.space/README.md

138 lines
4.8 KiB
Markdown
Raw Normal View History

2022-01-17 10:32:33 +00:00
# lumbung.space
2021-12-15 09:53:32 +00:00
2022-01-17 10:32:33 +00:00
[![Build Status](https://drone.autonomic.zone/api/badges/ruangrupa/lumbung.space/status.svg?ref=refs/heads/main)](https://drone.autonomic.zone/ruangrupa/lumbung.space)
2022-01-05 10:02:44 +00:00
2022-07-18 10:30:48 +00:00
![lumbung.space logo](https://lumbung.space/img/alt-lumbung-logo.jpeg)
2021-12-15 11:31:46 +00:00
2022-07-18 10:30:48 +00:00
> lumbung.space is an online platform by and for the lumbung-interlokal and lumbung artists. Many of the artists and collectives invited for documenta fifteen are located far away from each other, with their own contextual realities and vulnerabilities. To be able to work together over such distances, the act of documenting the process, writing together, and keeping each other informed within the network is one of the most important parts of the process of building the lumbung. This process is known as harvesting. Thus, lumbung.space was made to provide a number of tools and a collective publishing outlet for this diverse network to experiment and share the collective processes through harvests. Like a vibrant archive and a digital living room, it allows connection, support, and sharing of knowledge. Learn more on [lumbung.space](https://lumbung.sace)...
## Technical FAQ
2022-01-05 12:00:42 +00:00
### How does the CI/CD work?
2022-01-17 10:32:33 +00:00
The [`.drone.yml`](./.drone.yml) triggers a build on [drone.autonomic.zone](https://drone.autonomic.zone/ruangrupa/lumbung.space) of the [`Dockerfile.hugo`](./Dockerfile.hugo) and the [`Dockerfile.scripts`](./Dockerfile.scripts) and then deploys the [`compose.yml`](./compose.yml) stack using `docker stack deploy`.
2021-12-15 11:31:46 +00:00
2022-01-05 12:00:42 +00:00
### How often is the content regenerated?
See the `sleep ...` statements in the [`compose.yml`](./compose.yml).
2022-01-05 12:06:27 +00:00
### How do I see if content generation is working?
(requires `lumbung.space` docker context)
- `docker service logs -f beta_lumbung_space_peertube`
- `docker service logs -f beta_lumbung_space_calendar`
- `docker service logs -f beta_lumbung_space_feed`
2022-01-05 12:06:27 +00:00
Where `beta_lumbung_space_<service-name>` and you see the service name in the [`compose.yml`](./compose.yml).
2022-01-05 13:14:05 +00:00
### How do I add a feed?
2022-01-17 10:32:33 +00:00
Add your RSS feed URL to [`feeds_list.txt`](./feeds_list.txt) and don't forget [this deploy step](https://git.autonomic.zone/ruangrupa/lumbung.space#deploy-a-new-feeds_list-txt).
2022-01-05 13:14:05 +00:00
2022-01-05 13:32:33 +00:00
### How do I wipe all the generated content?
(requires `lumbung.space` docker context)
`docker exec -it $(docker container ls -q -f name=beta_lumbung_space_app) bash -c "rm -rf /src/content/*"`
2022-01-05 12:00:42 +00:00
## Hacking
2021-12-15 11:37:21 +00:00
### Generate the site
2022-01-05 12:00:42 +00:00
[Install Hugo](https://gohugo.io/getting-started/installing/) and `hugo serve --watch`
2021-12-15 11:37:21 +00:00
2021-12-15 11:31:46 +00:00
### Generate `lumbung[dot]space` posts
2021-12-15 11:40:25 +00:00
Do this manually first:
2021-12-15 11:31:46 +00:00
```
2021-12-15 11:35:29 +00:00
mkdir -p content
python3 -m venv .venv && source .venv/bin/activate
2022-07-18 10:30:48 +00:00
pip install git+https://git.autonomic.zone/ruangrupa/konfluks
2021-12-15 11:35:29 +00:00
export CALENDAR_URL="https://cloud.lumbung.space/remote.php/dav/public-calendars/WbnHM8YdCkKT6bcT?export"
export OUTPUT_DIR=content/calendar
2022-07-18 10:30:48 +00:00
konfluks-cal
2021-12-15 11:35:29 +00:00
export OUTPUT_DIR=content/tv
2022-07-18 10:30:48 +00:00
konfluks-vid
export OUTPUT_DIR=content/shouts
2022-07-18 10:30:48 +00:00
konfluks-feed # reads ./feeds_list.txt
export OUTPUT_DIR=content/social
export MASTODON_AUTH_TOKEN=foobar
2022-07-18 10:30:48 +00:00
konfluks-hash
2021-12-15 11:31:46 +00:00
```
2021-12-15 11:40:25 +00:00
Afterwards, you can automatically run it with `make gen`.
2022-01-05 12:00:42 +00:00
2022-07-18 10:30:48 +00:00
After a `git pull`, you may need to run `pip install git+https://git.autonomic.zone/ruangrupa/konfluks` again.
2022-01-05 12:50:35 +00:00
2022-01-05 12:00:42 +00:00
### Manually deploying new images
- `docker login -u decentral1se -p $(logins/dockerhub/decentral1se)`
- `make push-hugo`
- `make push-scripts`
### Manually deploy the site
(requires `lumbung.space` docker context)
- `make deploy`
### Deploy a new `feeds_list.txt`
2022-01-05 13:14:05 +00:00
Increment the `_v<n>` (e.g. `v1` -> `v2`) in [`compose.yml`](./compose.yml) `configs` to avoid any deployment error.
2022-09-15 12:04:59 +00:00
2022-09-15 12:10:50 +00:00
### Adding a leaflet map to a page
2022-09-15 12:04:59 +00:00
To add a new leaflet map use the shortcode:
```
{{< map geoJson="data/geojsonContributors.json">}}
```
This way you can display a map on any page with any data.
To add data to the map, add a new json file to the `data/` directory and use the [geojson datascructure](https://geojson.org/) in the json file.
Then point the `geoJson="data/newfile.json"` in the shortcode to the new file.
2022-09-20 06:46:22 +00:00
If you wanna display new test in the tooltips just add a new property key/value.
2022-09-15 12:04:59 +00:00
e.g.
```
"properties": {
"a": "new value",
}
```
One catcha is that Javascipt always output the order of the object in alfabetic order, there is nothing to do about this.
Key names `groupName` and `listOfNames` are reserved.
This will display it in the way it does now on the map
e.g.
```
"properties": {
"groupName": "The Question of Funding",
"listOfNames": [
"Adele Jarrar",
"Amany Khalifa",
]
}
```
So just to be clear if you want extra value under it, give the key name a letter that is after the `l` in the alfabet.
e.g.
```
"properties": {
"groupName": "The Question of Funding",
"listOfNames": [
"Adele Jarrar",
"Amany Khalifa",
],
"m": "value under the list"
}
```
The new added value will alway be displayed the same and will be in a `<p>` tag.