web-landing-page/README.md
Benoit Donneaux 8348cd8bfd
All checks were successful
Jekyll / jekyll (pull_request) Successful in 37s
Support checks in forked repositories
Signed-off-by: Benoit Donneaux <benoit@leastauthority.com>
2025-08-19 11:11:21 +02:00

1.2 KiB

Web landing page for the Tahoe-LAFS project

The goal of this web page is to represent the Tahoe-LAFS project to the public.

It gives guidance on getting started for end-users, developers building with Tahoe-LAFS and hackers interested working on Tahoe-LAFS itself alike.

Building

This web page is built and deployed by CI. A preview is also automaticaly genereated for PRs made from branches local to this repository (require push/write permission).

If you want to pre-view your changes on your local machine before pushing commits, you might want to start a development server.

Issuing this command on a system with Docker runs a web server on http://localhost:4000/ that re-builds and refresh the page automatically on source file change:

docker-compose up

Contributing

We welcome contributions! Easiest is to open tickets or pull requests directly. If unsure, join the IRC or ask on the Tahoe-LAFS developer mailing list.

Caveat: because they need access to the repository secrets (e.g. SSH private key), the deployment step will be skipped on forked repositories. Which means preview sites will only be published from local branches pushed by collaborators with permissions to write in this repository.