bugfishtm/obr repository overview

⁠Online-Book-Renting (OBR)

⁠🔍 Overview

Simple book rental software with user-friendly features, multi-language support, and efficient ISBN management.

⁠⚙️ Installation

To deploy the Docker image bugfishtm/obr:latest using a single command, you can use the following:

docker run -d --restart always -p 80:80 -p 443:443 -e sf_db_pass=your_password -e sf_url=your_url -e sf_timezone=Europe/Berlin -v obr_data:/var/www/html/_data -v obr_mysql:/var/lib/mysql bugfishtm/obr:latest

This command does the following:

• Runs the container in detached mode (-d)
• Set the startup policy to start always, so the container will not stop if the system performs a reboot.
• Maps ports 80 and 443 from the container to the host
• Sets required environment variables (-e)
• Creates and mounts volumes for persistent data (-v)
• Uses the bugfishtm/obr:latest image from Docker Hub

Replace your_password, your_url, and your_timezone with appropriate values. The volumes obr_data and obr_mysql will be created automatically if they don't exist.

⁠Initial Login

Initial user account for the website after deployment:
username: [email protected]⁠
password: changeme

⁠Variables

⁠Volumes

⁠Ports

⁠Useful Links

• Github⁠
• Documentation⁠

⁠📖 Documentation

The following documentation is intended for both end-users and developers.

⁠❓ Support Channels

If you encounter any issues or have questions while using this software, feel free to contact us:

• GitHub Issues is the main platform for reporting bugs, asking questions, or submitting feature requests: https://github.com/bugfishtm/Online-Book-Renting/issues⁠
• Discord Community is available for live discussions, support, and connecting with other users: Join us on Discord⁠
• Email support is recommended only for urgent security-related issues: [email protected]⁠

⁠📢 Spread the Word

Help us grow by sharing this project with others! You can:

• Tweet about it – Share your thoughts on Twitter/X⁠ and link us!
• Post on LinkedIn – Let your professional network know about this project on LinkedIn⁠.
• Share on Reddit – Talk about it in relevant subreddits like r/programming⁠ or r/opensource⁠.
• Tell Your Community – Spread the word in Discord servers, Slack groups, and forums.

⁠🤝 Community Guidelines

We’re on a mission to create groundbreaking solutions, pushing the boundaries of technology. By being here, you’re an integral part of that journey.

Positive Guidelines:

• Be kind, empathetic, and respectful in all interactions.
• Engage thoughtfully, offering constructive, solution-oriented feedback.
• Foster an environment of collaboration, support, and mutual respect.

Unacceptable Behavior:

• Harassment, hate speech, or offensive language.
• Personal attacks, discrimination, or any form of bullying.
• Sharing private or sensitive information without explicit consent.

Let’s collaborate, inspire one another, and build something extraordinary together!

⁠🛡️ Warranty and Security

I take security seriously and appreciate responsible disclosure. If you discover a vulnerability, please follow these steps:

• Do not report it via public GitHub issues or discussions. Instead, please contact the [email protected]⁠ email address directly.
• Provide as much detail as possible, including a description of the issue, steps to reproduce it, and its potential impact.

I aim to acknowledge reports within 2–4 weeks and will update you on our progress once the issue is verified and addressed.

This software is provided as-is, without any guarantees of security, reliability, or fitness for any particular purpose. We do not take responsibility for any damage, data loss, security breaches, or other issues that may arise from using this software. By using this software, you agree that We are not liable for any direct, indirect, incidental, or consequential damages. Use it at your own risk.

⁠📜 License Information

The license for this software can be found in the LICENSE.md⁠ file.

🐟 Bugfish