Initial Upload
This commit is contained in:
97
README.md
Normal file
97
README.md
Normal file
@@ -0,0 +1,97 @@
|
||||
# Cloud-CMS
|
||||
|
||||
Cloud-CMS is a powerful **Open Source Digital Signage platform** with a web-based content management system and display player software. It enables you to manage and deliver dynamic content across multiple screens from a centralized interface.
|
||||
|
||||
We offer commercial player options for Android, LG webOS, and Samsung Tizen, as well as CMS hosting and support services.
|
||||
|
||||
For more information about the original project, visit [Xibo Signage](https://xibosignage.com).
|
||||
|
||||
---
|
||||
|
||||
## About Cloud-CMS
|
||||
|
||||
Cloud-CMS is based on the Xibo CMS project and provides everything you need to run a digital signage network or a single screen. Our goal is to make digital signage accessible, flexible, and easy to manage.
|
||||
|
||||
---
|
||||
|
||||
## Features
|
||||
|
||||
- Web-based content management
|
||||
- Layout and playlist scheduling
|
||||
- Support for multiple display types and players
|
||||
- API for integration with third-party systems
|
||||
- Docker-based deployment for easy setup
|
||||
|
||||
---
|
||||
|
||||
## Installation
|
||||
|
||||
### Quick Installation Guide
|
||||
|
||||
We recommend installing an official release via **Docker**.
|
||||
Follow these steps to quickly install **Cloud-CMS** using Docker:
|
||||
|
||||
1. **Install Docker and Docker Compose**
|
||||
- Download and install Docker from [https://docs.docker.com/get-docker/](https://docs.docker.com/get-docker/).
|
||||
|
||||
2. **Create a Project Directory**
|
||||
```bash
|
||||
mkdir cloud-cms
|
||||
cd cloud-cms
|
||||
```
|
||||
|
||||
3. **Download the Docker Compose File**
|
||||
- Obtain the official `docker-compose.yml`
|
||||
|
||||
4. **Configure Environment Variables**
|
||||
- Create a `.env` file and set values for:
|
||||
- `MYSQL_PASSWORD`
|
||||
- `CMS_DB_NAME`
|
||||
- `CMS_DB_USER`
|
||||
- `CMS_DB_PASSWORD`
|
||||
|
||||
5. **Start the Containers**
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
6. **Access Cloud-CMS**
|
||||
- Open your browser and navigate to `http://localhost` (or your server IP).
|
||||
|
||||
|
||||
|
||||
---
|
||||
|
||||
## Development
|
||||
|
||||
Please only install a development environment if you intend to make code changes to Cloud-CMS. Installing from the repository is not suitable for production installations.
|
||||
|
||||
Cloud-CMS uses Docker to ensure all contributors have a repeatable development environment that is easy to set up.
|
||||
|
||||
---
|
||||
|
||||
## Support
|
||||
|
||||
Cloud-CMS is supported by **Oribi Technology Services**.
|
||||
For assistance, please use one of the following options:
|
||||
|
||||
- **Submit a ticket:** [https://portal.oribi-tech.com/new-ticket](https://portal.oribi-tech.com/new-ticket)
|
||||
- **Email:** [support@oribi-tech.com](mailto:support@oribi-tech.com)
|
||||
|
||||
---
|
||||
|
||||
## License
|
||||
|
||||
Copyright (C) 2006-2025 Xibo Signage Ltd and Contributors.
|
||||
|
||||
Cloud-CMS (based on Xibo CMS) is free software: you can redistribute it and/or modify it under the terms of the **GNU Affero General Public License** as published by the Free Software Foundation, either version 3 of the License, or any later version.
|
||||
|
||||
Cloud-CMS is distributed in the hope that it will be useful, but **WITHOUT ANY WARRANTY**; without even the implied warranty of **MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE**. See the GNU Affero General Public License for more details.
|
||||
|
||||
You should have received a copy of the GNU Affero General Public License along with Cloud-CMS. If not, see [http://www.gnu.org/licenses/](http://www.gnu.org/licenses/).
|
||||
|
||||
---
|
||||
|
||||
## Attribution
|
||||
|
||||
Cloud-CMS is a white-label version of the Xibo CMS project. Original source code and documentation are available at [Xibo CMS GitHub Repository](https://github.com/xibosignage/xibo-cms).
|
||||
Reference in New Issue
Block a user