📄 Round Review

Round Review is a PDF platform to manage documents and reviews with collaborators.

Checkout more screenshots here.

Features

• 📁 Create and manage projects with PDF documents
• 👥 Invite and manage users in each project
• 📄 Upload, view, and edit PDFs
  • Includes night mode for comfortable viewing

• 💬 Click & comment on PDFs for reviewers and project owners

• 🎨 Multi-theme support (light/dark)
• 🔐 Basic and advanced user access
  • Includes GitHub OAuth integration
• 🔔 Webhook support for notifications
• 🔌 API-based access to all features
  • 📚 Documentation is currently under development
• 🐳 Docker-based deployment configurable via .env
• 🛡️ System admin panel with audit logs
• 🤖 Plugins with Bot Integration Review
  • Supports external bots via 3rd-party API for document reviews
    • 📝 Example 1: When a document is Approved, apply a signature to the PDF
    • 🧠 Example 2: Integrate AI with LLM to create summaries and automatic reviews

Note

The project is under active development and the current version is in beta

📄➕ Plugins

If you want to add plugins 📄➕ to your Round Review instance, checkout Round Review Plugins.

Installation and Maintenance

Important

Follow these instructions to get the container up and running properly

Requirements

• Docker with Docker Compose (v2+)

First installation

1. Clone the repository in your system
   • git clone https://github.com/Maxelweb/RoundReview.git
2. Prepare the environment variables file
   • cp envs/template.rr-app.env envs/rr-app.env
3. Edit the environment file envs/rr-app.env according to your needs (see envs documentation)
4. Start the Round Review (app) container
   • docker-compose up roundreview_app -d --build
5. Go to localhost:8080
   • In case of port error (e.g. already in use), change the port inside the docker-compose
   • To stop this, use docker-compose down roundreview_app

Default admin credentials

The following credentials applies only if you didn't change the default environment variables configuration.

• Email: [email protected]
• Password: <randomly generated> (check docker logs)

Warning

If you didn't change the default admin password to something else, you MUST check the logs from the docker container to get the generated password (docker logs roundreview_app). If you missed it, restart from scratch by removing the volumes created.

Manage the Docker stack

1. docker-compose up -d: Start all containers in the stack
2. docker-compose down: Stop all containers in the stack

Tip

Copy docker-compose.yml and paste as docker-compose.custom.yml. Then customize the stack according to your needs.

1. docker-compose -f docker-compose.custom.yml up -d
2. docker-compose -f docker-compose.custom.yml down

Updates the Docker stack

1. git pull the last updates from the git repository
2. docker-compose up -d --build: Start and build all containers; this will automatically update the internal database

Documentation

Go to docs/ folder for more documentation.

License and Credits

Apache 2.0 License

Developed by Maxelweb for anyone!