Seed

Seed is a decentralized knowledge collaboration application for open
communities powered by a knowledge graph.

You can read more about the product and why we are here on our website: https://seed.hyper.media.

Hypermedia Protocol

Seed Hypermedia is powered by the new Hypermedia Web Protocol. This
open protocol provides secure identities, version control, semantic documents, multimedia,
and groups/organizations.

Desktop App + Web Server

This repo includes:

1. Seed Desktop - app for writing, reading, and saving Hypermedia content
2. Seed Hypermedia Web Server - public web experience, a read-only portal of the Hypermedia network

⚠️ Stability

This is software is being actively developed, and may contain bugs and rough edges.
We appreciate any feedback and bug reports, so if you find any, please open an issue.

The permanent data format has been declared stable, and we don't expect any breaking changes there.
Documentation is still missing though, but it will come.

We still recommend you to have a copy of anything valuable you put into the app, while we are polishing it,
and improving the overall stability.

Dev Environment

See the developer setup page for detailed instructions.

The dev environment on macOS+Linux uses the Mise,
and Direnv.

The bare minimum required for compilation is to have Go, and NodeJS toolchains
installed.

./dev is the main dev CLI. Run ./dev to list commands, including:

• ./dev run-desktop
• ./dev run-desktop-mainnet
• ./dev build-desktop
• ./dev run-site
• ./dev build-site

To run the dev build with the production network, use the following command:

SEED_P2P_TESTNET_NAME="" ./dev run-desktop

Frontend Testing

pnpm test               # test all the packages
pnpm desktop:test       # test desktop app (e2e only now)
pnpm site:test          # test only site code (WIP)

Web Build

Group sites

Group sites need two programs to run. The daemon which includes the P2P node (go app)
and the frontend that renders documents (nextjs app). However for a production
deployment everything is orchestrated by docker compose. Read next sections for how to
either deploy a site on a production server or run it locally in dev mode

Deploy a Group Site

To deploy a group into a site, make sure you have a domain name and
a server with the following requirements:

1. At least 2GB RAM
2. Al least 512MB free space in root partition.
3. Port 56000 open so the p2p connections can reach the server.

After checking that, run the following command in the server:

sh <(curl -sL https://raw.githubusercontent.com/seed-hypermedia/seed/main/website_deployment.sh) https://example.com

replacing https://example.com by your <address> If everything went well,
after some seconds, you should be watching a final output line like
https://example.com/secret-invite/XXXX. You should paste that link back into
the owner's application to register the newly created site and start publihing.
The site deployment workspace will default to ~/.seed-site.

Auto-Update a Site

If you want the site to auto update to latest stable images when they are pushed,
just execute the installation command with the --auto-update flag. Ex:

sh <(curl -sL https://raw.githubusercontent.com/seed-hypermedia/seed/main/website_deployment.sh) https://example.com --auto-update

Replace Site

If you want to replace an old site with a new site in a different domain in the same machine,
you need to redeploy the site from scratch. Note that old content will be available as long as
the owner of the site is synced with the site at the moment of the replacement. On the server:

docker stop seed-web
mv ~/.seed-site ~/.seed-site.bak
docker start seed-web

Get the new secret link from the command line after starting the seed-web container
Now in the Seed App, the Owner of the site can go to the group he/she wants to (re)deploy
and click on the three dots, and publish group to site. Enter the new secret and the old content
should be now available in the new site. If there is no new content (A completely new group), then
the site will be empty ready to accept documents