onasaft
/
Discover
1
3
Fork 3
Code Issues 3 Pull Requests Projects Releases Wiki Activity
A web directory generator. https://onasaft.codeberg.page/discover/
71 Commits
2 Branches
0 Tags
638 KiB
Shell 100%
 
Go to file
tfasano1 86dd7520d2 whoops 2023-02-12 18:30:56 -05:00
.well-known example json 2022-08-20 15:26:04 -04:00
Docs make about field the link title in previews 2023-01-14 20:42:17 -05:00
LICENSE Initial commit 2022-05-17 20:49:52 +02:00
README.md Update 'README.md' 2023-01-05 17:24:38 +00:00
discover.sh whoops 2023-02-12 18:30:56 -05:00

README.md

Discover - a web directory generator

Discover is a web directory generator to promote personal site discovery such that everyone owns their data.

In this repository, you will find the main client, though others have and can make their own. It's a shell script which builds your discovery directory from a json file hosted by you. This script is periodically called by a cronjob, which updates said page. Then nginx serves this page statically. If one of your contacts decides to go incognito, or simply change their profile picture, these changes will be reflected without any effort on your part.

Follow these steps to become discoverable:

  1. Grab the example json file
  2. Check out the docs
  3. Modify it with your data
  4. Serve that file from your.website/.well-known/discover.json

How do I show previews on my site?

  1. Install dependencies: apt install -yy jq curl
  2. Clone this repo
  3. Copy the discover.sh script to your webroot:
  4. chmod +x discover.sh
  5. Run ./discover.sh -h to see scripting options. You can manually add your site in the script if you don't wish to use the -s flag
  6. Make a new cronjob: crontab -e
  7. 0 */2 * * * /bin/sh -c 'cd /var/www/your.website; ./discover.sh'

This will refresh your page at the start of every 2nd hour each day. Visit cron.help to help find an update rate which is slightly different than the example to lessen bandwidth strain. Please make sure your directory is being updated at least once a day.

The cronjob will build your page but if you don't want to wait, run the discover script locally (use the remote url option) and upload it to your server.

Now go to your.site/discover (or whatever's the name of your client's page) You should see your json file displayed as a web directory, as well as previews of other people's sites you chose to connect with.

It's recommended to use a json linter before publishing your data

Repeat this process if you have more than 1 website. Now you're done!

Can I embed my "discover" page in my links page?

Yes! One hacky way is to use an iframe.

Credits

Idea came from Interverse