bugfishCMS Documentations
This is the Documentation for "Bugfish bugfishCMS"
Download GithubThe "bugfishCMS" Project
Welcome to the bugfish-cms Project, a pioneering web development solution designed to streamline your web development endeavors. This dynamic platform offers a rich set of features, including native support for dynamic CSS, JavaScript, and Cronjobs. It equips you with the essential tools to effortlessly create and maintain web applications. Whether you seek diverse design styles or the convenience of pre-installed, fully functional libraries from the "Bugfish Framework," our project caters to all your web development requirements.
This repository hosts a framework is a complete out-of-the-box CMS (Content Management System) that can be easily set up in the frontend. It is mainly designed for individuals with coding expertise who wish to develop their own modules. While there are built-in functionalities available in the administrator interface for various purposes, the primary emphasis of this system lies in its extensibility. Users are encouraged to create and integrate site modules to tailor the framework to their specific requirements, making it a flexible and adaptable solution for those who have the technical skills to harness its potential.
Powerful Administrator Module!
The administrator module bundled with "bugfishCMS" CMS is a robust toolkit designed to empower users with efficient management capabilities. Packed with essential features, it facilitates seamless administration of your website or application.
With user management functionalities, you can effortlessly control access and permissions, ensuring secure interactions within your platform. The API token management system enhances integration possibilities, enabling smooth communication with external services and applications.
Harness the power of constants for settings management, simplifying configuration processes and ensuring consistency throughout your project. Multi-site management capabilities allow you to efficiently oversee multiple sites from a single interface, streamlining your workflow.
The module also includes a comprehensive module and extension store, providing developers with a rich ecosystem of tools to extend functionality and enhance user experience. Bookmark management and file sharing features further enhance productivity, allowing users to organize and share important resources effortlessly.
Showcase article and task management functionalities empower content creators to curate and manage content effectively. Calendar functionalities facilitate efficient scheduling and planning, while the integrated multi-site functioning wiki, forum, and logging and debugging functionalities offer deep insights and collaboration opportunities.
Developers and users alike will appreciate the robust documentation provided, ensuring ease of use and seamless integration with existing workflows. Whether you're a developer seeking powerful tools or a user in need of efficient management capabilities, the administrator module of "bugfishCMS" CMS delivers exceptional functionality and versatility.
Screenshots
Here you can find some screenshots about this project!Collaboration & Support
Your feedback and contributions are incredibly valuable to us as we continuously aim to refine our documentation and improve accessibility to our project for all users. Your support and understanding play a pivotal role in our journey towards enhancement. Collaboration lies at the heart of our efforts, and we welcome your active participation in shaping the project's evolution.
To facilitate seamless collaboration and support, we've established a dedicated forum at www.bugfish.eu. This platform serves as a hub where users can raise issues, share insights, and engage in discussions, enabling us to promptly address queries and provide comprehensive support. Your presence on the forum enriches our community and strengthens our collective pursuit of delivering an exceptional user experience. We encourage you to join us on the forum, contributing your thoughts and experiences to foster a thriving environment of collaboration and assistance.
Add this image to your project created with this CMS to support us!
Powered by Bugfish-Framework
This software is powered by the bugfish-framework software! You can find the dedicated php/js/css bugfish framwork on github.
bugfishCMS Logo
Below you can see the current Logo of this bugfish-cms System!
Project Goal
Our primary goal with this project is to expedite and enhance multi-site deployment. Recognizing the paramount importance of swiftly launching web projects, we are committed to delivering a cutting-edge web hosting solution. We are in the process of implementing these advanced technologies into a new hosting panel, poised to redefine the web hosting landscape. Join us on this thrilling journey as we work towards reshaping web hosting as we know it.
Installation
Here you can find some information about the installation process!
Requirements
- Apache2 Webserver Recommended
- Apache2 Modules: Rewrite, Header
- PHP 8 Recommended
- Website will ask for missing PHP Modules
- MariaDB Database Connection
Method 1: Manual Installation
Here you can see a list of steps on how to install the cms manually. This method is recommended!- Upload all files out of this repositories _source directory to your webspace public-html folder!
- Visit your URL in a Webbrowser, which points to the folder you just uploaded the files to.
- Go to ./installer.php and Install the CMS by providing required data.
- After the Installation you will be redirected to the CMS Login Page
- Login with data provided below in "Initial Login"
- You can now use the CMS and install new modules or extensions out of our official store! You can deploy your own modules to the _site folder, or use the installation manager at the administrator interface! You can develop own modules and remove the optional administrator module. You can even use standalone modules for single site instances. This CMS will be the only thing you need to accomplish every possible PHP Website goal!
Method 2: Docker Installation
Here you can find some steps to install the CMS with docker. You will find related files in the repositorie. Check the composer file for required changes and deploy the docker container by running the bat file on windows or the sh file on linux!- Docker Files are included to install this software with a docker container.
- Check docker-compose.yml
- Check .env for internal container mysql password (needed for cms installation)
- Windows: Execute the .bat file in the repositories Root Folder.
- Linux: Execute the .sh file in the repositories Root Folder
- The Docker container should now start to initialize
- If the docker container have been initialized go to your domain:658 (port 658) and you can see the deployed docker image featuring the bugfishcms. You can change the exposed port in the docker-compose.yml
- Go to ./installer.php and Install the CMS by providing required data.
- After the Installation you will be redirected to the CMS Login Page
- Login with data provided below in "Initial Login"
- You can now use the CMS and install new modules or extensions out of our official store! You can deploy your own modules to the _site folder, or use the installation manager at the administrator interface! You can develop own modules and remove the optional administrator module. You can even use standalone modules for single site instances. This CMS will be the only thing you need to accomplish every possible PHP Website goal!
Initial Login
Initial Login Data
The initial Login data if you are using the _administrator site module or loging functionality by core is as follow:
Username: admin@admin.local
Password: changeme
If upper steps for initial login are not working try admin/changeme. It depends on various site module configurations and in standalone mode default initial login can be setup in the site modules config files.
How to install Modules?
Here a quick overview on how to install modules!Method 1: Install by Moving Module Folder to _site
- Download the Modules zip achieve you need to install.
- Module Zip Archives are usually named like: modulename-1.0.100
- Unzip the Site Modules Zip File Manually
- You should now have the site modules folder containing files like "version.php" and more.
- Move that folder to the websites CMS _site folder.
- You can deploy site modules multiple times, the folder name of a site module represents its _HIVE_MODE_ internal site module name.
Method 2: Installation with Admin Interface + File
- Download the Modules zip achieve you need to install.
- Module Zip Archives are usually named like: modulename-1.0.100
- Login to the CMS _administrator Website Module
- Go the System/Module section and choose "Upload"
- Upload the site Modules zip file to the section for manually uploaded site modules and extensions.
- Active / deploy the Installed Module in the Administrator Interface.
Method 3: Installation with Admin Interface + Store
You can also download modules manually at our store at https://store.bugfish.eu.- Login to the CMS _administrator Website Module
- Go the System/Module/Store section and choose a module/extension you want to download
- Active / deploy the Downloaded Module in the Administrator Interface.
Integrated Modules
Following modules may be interesting for developers to enhance theire knowledge about bugfish-cms Functionalities! You can find these modules in the repositories _module folder and deploy them by copying them into the websites _site folder! You should never manually rename a deployed site module, as this will result in data loss and missing links. Use our administration or another administration interface module to deploy and manage modules! For developres use cfg_ruleset_sample.php to achieve your needs!
Name | Description |
---|---|
_documentation-adminbsb | Documentation for integrated AdminBSB Template |
_documentation-framework | Documentation for integrated Bugfish Framework |
_documentation-volt | Documentation for integrated Volt Administrator Theme |
_example-minimal | Minimal Site Module Solution for Developers to use as a Template |
_example-windmill | Windmill Dashboard Site Module example with some more advanced functionalities |
_example-volt | Volt Dashboard Site Module example with some more advanced functionalities |
_documentation | Documentation for this CMS integrated as a Site Module |
_windmill-backend | Backend to be copied or used side-by-side with your BugfishCMS-Page, based on Windmill Dashboard |
_skeleton | Skeleton of site modules for developers to look into to understand folder functionalities and more! |
_administrator | Default advanced Administrator Interface module to be used/reused/copied and more! |
_storepage | Out official Store Module to show our store page at store.bugfish.eu! |
Features
Our web project offers a wide range of powerful features that are designed to simplify your web development journey. These key functionalities provide you with the tools and capabilities you need to create, manage, and customize websites effectively.
Full integrated enhanced Administration Panel
This CMS comes with a fully functioning responsive administration backend, for you to be used in development of site modules or just to enjoy the many functions of it! Included is file management, user management, debugging insights of all available CMS Debugging areas. The _administrator Module Grants you access to our store, or helps you setting up your own store instance of you need one! Functions are included to easily use all advanced theme functionalities of the AdminBSB Material Design! The _administrator module is delivered with the bugfish-cms cms by default. You can choose if you want to delete this admin module and built your own standalone website, or if you want to copy if for your own project! You can even use our administrator module site by site with your pages, or you can set up own site by site procedures following our guidelines! Have fun coding!
Full features Administration Interface
Full featured Administration Module (undeleteable, but you can delete it if you want to use this framework for a standalone module development or for your purposes). This administrator Module lets you control most functionalities of the framework and CMS and you can easily set up additional pages and themes out of the store.
Copyable Site by Site Backend Lite Modules
CMS _windmill-backend Site Module offers a way to navigating the platform, emphasizing a fully copyable and usable admin interface. This feature facilitates efficient content management, user administration, and streamlined control over various system functionalities.
Store System and Site Module Downloads
Included within the CMS is a complete working store system. Users can either utilize this system independently or integrate it with the official store to access and download diverse site modules, enhancing their websites with customizable features.
Site Module Updating Functionalities
This CMS got single Site Module Updating Functionalities, providing users with clear instructions on how to update and maintain site modules. This functionality ensures that websites remain current with the latest features, improvements, and security updates.
User Interface Tailored for Developers
Tailored specifically for developers, the CMS gives a comprehensive user interface. This section focuses on enabling developers to access and manipulate the system through coding, allowing for extensive customization and advanced functionality implementation to meet diverse project requirements.
Multi-Site Management
Effortlessly oversee and manage multiple websites within a unified framework, enhancing your web project management capabilities. With our intuitive interface, you can keep all your web properties organized and easily switch between them.
Build Pages with Templates
Our system includes a feature that allows you to design your own web pages with the assistance of pre-designed and extendable widgets. This empowers you to create visually stunning and user-friendly pages.
Build Procedures with Included Functions
Create complex workflows and procedures for various tasks or operations using our included and extendable widgets. These procedures provide a structured approach to managing tasks, making it easier to collaborate and optimize your workflow.
Rights and User Management
Streamline permissions and user role management with our user-friendly tools. This functionality enables you to control access and bolster security, ensuring that the right people have the right level of access to your websites.
Example Site Modules
The "Example Site Modules" feature within the CMS offers a diverse range of pre-built website modules packaged within distinct folders. These modules encompass various functionalities and design elements, providing users with a rich library of ready-to-use components. What sets this feature apart is its integrated full working admin interface, empowering users to seamlessly navigate, customize, and manage these modules effortlessly. Whether users opt to employ these modules site-by-site or utilize them by copying and pasting directly into the designated /_site directory, the feature ensures a streamlined and flexible approach to enhance website development, enabling users to craft dynamic and efficient websites with ease.
"Bugfish Framework" Integration
Integrate seamlessly with the Bugfish Framework, a robust web development toolkit. For a comprehensive understanding and access to resources, please refer to our Bugfish-GitHub. This integration expands your capabilities and allows you to leverage the power of an established web development ecosystem. - you can find interesting informations to develope with "Bugfish-Framework" here: Click here to go to Bugfish-Framework's Documentation!
Dynamic Themes and Theme Colors
Customize themes and theme colors with ease to tailor your project's aesthetics. Enhance the visual appeal of your websites and create a unique online presence that reflects your brand identity.
Complex Site Building
Simplify the development of intricate websites with our user-friendly tools. Reduce development time and complexity, enabling you to focus on the creative aspects of your projects while we handle the technical intricacies.
Functions and Templates
Access an extensive range of functions and templates for rapid website deployment. Our toolkit offers a wide array of tools to enhance your web projects, making it easy to add advanced features and functionality to your websites.
Multi-Language Support
Expand your reach and reach a global audience by providing support for multiple languages. Make your websites accessible to diverse audiences, and ensure that language barriers do not hinder your online presence.
Database Change Updater
Dynamically update your database to align with the current build version. This ensures smooth transitions and robust database management, helping you maintain data integrity and system stability.
Installer Script
Simplify the initial setup of your web projects with our installer script. This hassle-free installation process ensures that you can get your websites up and running quickly, reducing the time and effort required for the initial setup.
Store and Core Updater
The software boasts two integral functionalities: a Core Updater service and Store functionality. Although the Store might currently display no projects, this is because no projects have been released by authors yet; however, this is anticipated to change in the future. Users have the convenience of easily altering both Store URLs and Core Updater URLs to suit their preferences, enabling them to manage their own core updates and customize their store operations as needed.
Libraries
This project relies on third-party libraries stored in the '/_core/_vendor' folder. For more information about these libraries, their respective licenses, and to access their source code, please refer to our GitHub repository, where you can find detailed information and links to each library.
Folder Name | License | Github Link |
---|---|---|
alpine | MIT | Link |
boxicons | MIT | Link |
sortablejs | MIT | Link |
choices.js | MIT | Link |
multi.js | MIT | Link |
select2 | MIT | Link |
tinymce | MIT | Link |
sweetalert2 | MIT | Link |
space_invader | MIT | Link |
resumable | MIT | Link |
modelviewer | Apache | Link |
leafletjs | BSD2 | Link |
jquery | MIT | Link |
bugfish-jquery-sortselect | GPLv3 | Link |
datatables | MIT | Link |
magicsuggest | MIT | Link |
free-file-icons | MIT | Link |
focustrap | MIT | Link |
chartjs | MIT | Link |
boxicons (Image List) | MIT | Link |
bugfish-dashboard | GPLv3 | None |
country-flags-icons | MIT | Link |
animate-css | HYP | None |
autosize | MIT | None |
animate | MIT | None |
bootstrap | MIT | None |
bootstrap-colorpicker | MIT | None |
bootstrap-material-datetimepicker | MIT | None |
bootstrap-notify | MIT | None |
bootstrap-select | MIT | None |
bootstrap-tagsinput | MIT | None |
chosen | MIT | None |
dropzone | MIT | None |
editable-table | MIT | None |
flot-charts | MIT | None |
gmaps | MIT | None |
ion-rangeslider | MIT | None |
jquery-cookie | MIT | None |
jquery-countto | MIT | None |
jquery-inputmask | MIT | None |
jquery-knob | MIT | None |
jquery-slimscroll | MIT | None |
jquery-sparkline | MIT | None |
jquery-spinner | MIT | None |
jquery-steps | MIT | None |
jquery-validation | MIT | None |
jvectormap | AGPL | None |
light-gallery | GPLv3 | None |
material-design-iconic-font | Apache | None |
materialize-css | MIT | None |
momentjs | MIT | None |
morrisjs | MIT | None |
multi-select | MIT | None |
nestable | MIT | None |
node-waves | MIT | None |
nouislider | MIT | None |
raphael | MIT | None |
waitme | MIT | None |
Windmill Theme | MIT | None |
Responsive Mail Template | MIT | None |
Responsive Error Page | MIT | None |
You-Login Resposive Template | MIT | None |
Volt Administrator Dashboard Lite | MIT | None |
Notyf | MIT | None |
Smooth-Scroll | MIT | None |
onscreen | MIT | None |
waypoints | MIT | None |
sass | MIT | None |
chatist | MIT | None |
githubbuttons | BSD | None |
animated-calender | BSD | None |
login-template | BSD | None |