Vvveb CMS

https://www.vvveb.com/docs/
Admin
Vvveb CMS is an open-source page builder and content management system that enables unrestricted...
Tokens:31,604
Snippets:783
Trust Score:9.8
Update:6 months ago
Show doc for...
Tokens:
Raw
### Run Vvveb CMS with Docker (Quick Start)

Source: https://www.vvveb.com/docs/docker-install

Use this command to quickly start Vvveb CMS with a default SQLite setup. Access the site at http://localhost:9000.

```bash
docker run -p 9000:80 vvveb/vvvebcms
```

--------------------------------

### Configure Subdirectory Installation

Source: https://www.vvveb.com/docs/installation

Manual configuration steps for running Vvveb from a subdirectory.

```php
defined('V_SUBDIR_INSTALL') || define('V_SUBDIR_INSTALL', '/vvveb');
```

```apache
RewriteRule ^ vvveb/index.php [L]
```

```nginx
try_files /page-cache/$host$cache_uri /page-cache/$host$cache_uri/index.html $uri $uri/ /subdir/index.php$is_args$args;
```

--------------------------------

### Access Local Installation

Source: https://www.vvveb.com/docs/installation

Default URL for accessing a local development installation.

```text
http://localhost/vvveb
```

--------------------------------

### Start Development Environment with Docker Compose

Source: https://www.vvveb.com/docs/docker-install

Command to start the development environment from the project root. Requires 'sudo' if not running as root. Access frontend at http://localhost:9000 and admin at http://localhost:9000/admin.

```bash
sudo docker-compose up -d
```

--------------------------------

### Install Vvveb via CLI

Source: https://www.vvveb.com/docs/installation

Use the command line interface for automated deployments or scripted installations.

```bash
php cli.php install module=index host=127.0.0.1 engine=mysqli user=root password= database=vvveb admin[email]=admin@vvveb.com admin[username]=admin admin[password]=123456 subdir=/vvveb
```

--------------------------------

### Start Docker Compose Stack

Source: https://www.vvveb.com/docs/docker-install

Command to start the services defined in your docker-compose.yaml file in detached mode. Access the site at http://localhost:9000.

```bash
docker compose up -d
```

--------------------------------

### Rule Interaction Example

Source: https://www.vvveb.com/docs/admin-role

Demonstrates allowing broad access to products while restricting specific management actions.

```text
product/*
```

```text
product/*/delete
product/categories
```

--------------------------------

### GET /component/products

Source: https://www.vvveb.com/docs/component-products

Retrieves a list of products based on specified filters, pagination, and sorting criteria.

```APIDOC
## GET /component/products

### Description
Displays a list of products based on provided configuration options.

### Parameters
#### Query Parameters
- **start** (integer) - Optional - Start offset for pagination, default 0
- **limit** (integer) - Optional - Number of products to display, default 4
- **page** (integer) - Optional - Page number
- **language_id** (integer) - Optional - Language id for name and content, default is current language
- **site_id** (integer) - Optional - Site id to show products for, default is current site
- **type** (string) - Optional - Custom product type, default is 'product'
- **manufacturer_id** (integer) - Optional - Filter by manufacturer id
- **vendor_id** (integer) - Optional - Filter by vendor id
- **order** (string) - Optional - Order by: 'product_id', 'price', 'date_added', 'date_modified'
- **direction** (string) - Optional - Order direction: 'asc', 'desc'
- **taxonomy_item_id** (integer) - Optional - Filter by taxonomy
- **include_image_gallery** (boolean) - Optional - Include product images, default true
- **product_id** (string) - Optional - Filter by product_id (single value or comma delimited list)
- **search** (string) - Optional - Filter products by name or description
- **slug** (string) - Optional - Filter by product slug (single value or comma delimited list)
- **related** (integer) - Optional - Filter products and show only related products for the given product_id
```

--------------------------------

### Wildcard Access Rules

Source: https://www.vvveb.com/docs/admin-role

Examples of using wildcards to define broad access or restriction patterns.

```text
content/*
```

```text
content/*/delete
```

```text
*/delete
```

```text
plugins/*
```

```text
plugins/contact-form
```

--------------------------------

### Docker Compose Example for Vvveb CMS with MySQL

Source: https://www.vvveb.com/docs/docker-install

This docker-compose.yaml file configures a MySQL database container and a Vvveb CMS container with persistent volumes and an internal network. Ensure DB_ENGINE is set to 'mysqli' for MySQL.

```yaml
services:
  db:
    image: mysql:latest
    restart: always
    environment:
      MYSQL_ROOT_PASSWORD: vvveb
      MYSQL_DATABASE: vvveb
      MYSQL_USER: vvveb
      MYSQL_PASSWORD: vvveb
    volumes:
      - db:/var/lib/mysql
    networks:
      - internal

  php:
    image: vvveb/vvvebcms:latest
    environment:
      DB_HOST: db
      DB_DATABASE: vvveb
      DB_USER: vvveb
      DB_PASSWORD: vvveb
      DB_ENGINE: mysqli # sqlite, pgsql also supported
    volumes:
      - vvveb-volume:/var/www/html
      - db:/var/lib/mysql
    ports:
      - "9000:80"
    links:
      - db:mysql
    depends_on:
      - db
    networks:
      - internal

volumes:
  vvveb-volume:
  db:

networks:
  internal:
    driver: bridge

```

--------------------------------

### Restrict Access to Admin and Install Folders

Source: https://www.vvveb.com/docs/apache-configuration

Set permissions to prevent unauthorized modification of sensitive directories.

```bash
chmod 744 admin install
```

--------------------------------

### Enable Vvveb Apache Configuration

Source: https://www.vvveb.com/docs/apache-configuration

Copy the provided configuration file to the sites-available directory and create a symbolic link to enable it.

```bash
sudo cp apache-vvveb.conf /etc/apache2/sites-available/vvveb.conf
sudo ln -s /etc/apache2/sites-available/vvveb.conf /etc/apache2/sites-enabled/vvveb.conf
```

--------------------------------

### Display Products with Options

Source: https://www.vvveb.com/docs/component-products

Use this HTML structure to display products. Configure pagination and image gallery settings using data attributes.

```html
<div data-v-component-products data-v-limit="10" data-v-page="2" data-v-include_image_gallery="0">

	<div data-v-product>
		<span data-v-product-name>Product name placeholder</span>
		<span data-v-product-price>$100</span>
		<img src="" data-v-product-image>$100</span>
		<a href="#" data-v-product-url>View product</a>
	</div>
</div>
```

--------------------------------

### GET /posts

Source: https://www.vvveb.com/docs/cat/components/3

Retrieves a list of posts with support for pagination and limiting results.

```APIDOC
## GET /posts

### Description
Displays a list of posts.

### Method
GET

### Endpoint
/posts

### Parameters
#### Query Parameters
- **start** (integer) - Optional - Start offset for pagination, default 0
- **limit** (integer) - Optional - Number of posts to display, default 4
- **page** (integer) - Optional - Page number, the number of pages is the total number of posts
```

--------------------------------

### Copy and Enable Nginx Configuration

Source: https://www.vvveb.com/docs/nginx-configuration

Copies the Vvveb Nginx configuration file and creates a symbolic link to enable it. Requires root privileges.

```bash
sudo cp nginx.conf /etc/nginx/sites-available/vvveb
sudo ln -s /etc/nginx/sites-available/vvveb /etc/nginx/sites-enabled/vvveb
```

--------------------------------

### Locate Media and Theme Directories

Source: https://www.vvveb.com/docs/migrating-to-new-server

Identify the folders containing uploaded files and theme assets that must be transferred to the new server.

```text
vvveb/public/media
vvveb/public/themes
```

--------------------------------

### Define Component Structure

Source: https://www.vvveb.com/docs/components-overview

Components are defined in HTML pages using the `data-v-component` attribute prefix. This example shows the structure for a product component.

```html
<div data-v-component-products>

	<div data-v-product>
		<span data-v-product-name>Product name placeholder</span>
		<span data-v-product-price>$100</span>
	</div>
</div>
```

--------------------------------

### Enable Apache Rewrite Module

Source: https://www.vvveb.com/docs/apache-configuration

Enable mod_rewrite and restart the Apache service to apply changes.

```bash
sudo a2enmod rewrite
sudo systemctl restart apache2
```

--------------------------------

### Set File Permissions for PHP Entry Points

Source: https://www.vvveb.com/docs/nginx-configuration

Sets read and execute permissions for the owner on PHP entry point files like index.php. This enhances security by restricting access.

```bash
744
```

--------------------------------

### Reload or Restart Apache

Source: https://www.vvveb.com/docs/apache-configuration

Apply configuration changes by reloading or restarting the Apache service.

```bash
sudo systemctl reload apache2
```

```bash
sudo systemctl restart apache2
```

--------------------------------

### Edit Apache Virtual Host Configuration

Source: https://www.vvveb.com/docs/apache-configuration

Open the configuration file for editing.

```bash
sudo nano /etc/apache2/sites-available/vvveb.conf
```
Tokens:
Raw