https://github.com/mrrpnya/pageshelf

A free and open source Pages server for your Forgejo instance
https://github.com/mrrpnya/pageshelf

actix-web forgejo pages rust rust-lang self-hosted server

Last synced: 12 days ago
JSON representation

A free and open source Pages server for your Forgejo instance

• Host: GitHub
• URL: https://github.com/mrrpnya/pageshelf
• Owner: mrrpnya
• License: mit
• Created: 2025-09-03T16:46:00.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2025-09-03T18:00:28.000Z (about 1 month ago)
• Last Synced: 2025-09-03T19:13:02.862Z (about 1 month ago)
• Topics: actix-web, forgejo, pages, rust, rust-lang, self-hosted, server
• Language: Rust
• Homepage:
• Size: 163 KB
• Stars: 1
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          




# Pageshelf

A free and open-source Pages server, written in safe Rust.

![GitHub branch check runs](https://img.shields.io/github/check-runs/mrrpnya/pageshelf/main)

![GitHub License](https://img.shields.io/github/license/mrrpnya/pageshelf)

![Static Badge](https://img.shields.io/badge/unsafe-forbidden-success)



## Supported software

- [x] Forgejo

This project follows a modular design; You can add your own providers, caches, and so on if needed.

## Features

- [x] Dynamic hosting of sites

  - [x] Simple `example.domain/user/repo(:branch))` style subdirectories

  - [x] `((branch).repo).user.example.domain` style subdomains

  - [x] Custom domains

- [x] Integration Tested

  - [x] In-Memory Mock

- [x] Caching Support

  - [x] Redis

- [x] Smart cache invalidation

- [x] [Anubis](https://github.com/TecharoHQ/anubis) compatibility

- [x] No client-side JS required

- [ ] Metrics

- [ ] Security

  - [ ] Whitelist/Blacklist

  - [ ] Auth-locking specific pages

  - [ ] Private repo serving

## Getting Started

### Docker

There is a [compose.yml](./compose.yml) included with this project - It shows how to use it via Docker Compose.

## License

Licensed under the terms of the MIT License. See [LICENSE](./LICENSE) for more information.