About Compass
"Compass" is a bookmark aggregation tool meticulously crafted to address the shortcomings of existing platforms such as Heimdall and Flame. Recognizing the need for enhanced collaboration and control, Compass introduces several groundbreaking features, including multi-user authentication, team functionalities, and customizable visibility settings for bookmark groups.
Key Features:
-
Multi-User Authentication: Compass takes bookmark management to a new level by introducing robust multi-user authentication. This feature allows teams and individuals to have secure and personalized access to their bookmarked content, ensuring data privacy and integrity.
-
Team Collaboration: One of Compass's standout features is its team collaboration functionality. Users can create teams, making it easier to collaborate on bookmark collections. This is especially beneficial for projects or departments that require shared access to curated resources.
-
Visibility Controls: Compass empowers users with granular control over the visibility of bookmark groups. You can designate specific groups to be visible only to certain teams, fostering a tailored and organized approach to information sharing within organizations.
-
Role-Based Access: To enhance security and streamline workflows, Compass incorporates role-based access controls. Administrators can assign different roles to team members, regulating their level of access and authority within the bookmarking system.
-
Centralized Administration Panel: A centralized administration panel makes managing user accounts, teams, and visibility settings straightforward. This ensures that administrators have a comprehensive view of the bookmarking ecosystem and can make real-time adjustments as needed.
-
User-Friendly Interface: Despite its powerful features, Compass maintains a user-friendly interface. Navigating through bookmark groups, teams, and visibility settings is intuitive, making the tool accessible to users with varying levels of technical expertise.
In summary, Compass is a bookmark aggregation tool that not only addresses the deficiencies of its predecessors but also introduces cutting-edge features like multi-user authentication, team collaboration, and visibility controls. It is positioned to transform how teams collaborate, share information, and manage their collective knowledge effectively.
Installing Compass
Docker
Environment variables
Name | Default |
---|---|
ADMIN_USERNAME | admin |
ADMIN_PASSWORD | password |
ADMIN_EMAIL | admin@app.test |
GITHUB_CLIENT_ID | |
GITHUB_CLIENT_SECRET | |
MICROSOFT_TENANT_ID | common |
MICROSOFT_CLIENT_ID | |
MICROSOFT_CLIENT_SECRET |
compass:
image: ghcr.io/kazuto/compass:latest
container_name: compass
ports:
- 80:80
volume:
- /path/to/dir:/config
environment:
- ADMIN_USERNAME=
- ADMIN_PASSWORD=
- ADMIN_EMAIL=
restart: unless-stopped
Manual Installation
Prerequisites
- PHP 8.1 or newer
Instructions
- Clone this repository
- Set the admin configuration
(default is admin/password)
ADMIN_USERNAME= ADMIN_EMAIL= ADMIN_PASSWORD=
- Run
composer setup
Optionally: If you want to enable SSO via GitHub or Microsoft
- Create a new
- Configure
.env
with app credentials - Create
whitelist
records in the settings page if not using Microsoft Single-Tenant
Contributing
Thank you for considering contributing to compass! The contribution guide can be found in the CONTRIBUTING.md.