Modern CMS
Get the tour
Documentation
API
User documentation
Write in Markdown
Titles
Alternate syntax
Bold
Italic
What if * character is already in use
Strike-through
Ordered and unordered lists
Nested list
New paragraph and line-break
Hypertext links
Block quotes
Images
Footnotes
Managing nodes
Node-tree navigation
Contextual menu actions
Creating a node
Edit an existing node
Node content
Node parameters
Side actions and parameters
Tags
SEO
Tree
Nodes publication system
Available statuses:
Preview unpublished nodes
Managing node-types
Add node-type
Delete node-type
Adding node-type field
Other actions
Managing documents
Upload document
Embed document
Random document
Unused document
Managing users
Create a new user
Delete user
Adding role
Other action
Enable SSO for back-office users
Developer documentation
First steps
Requirements
For Nginx users
For Apache users
CMS Structure
Install Roadiz Standard Edition
Dealing with Roadiz environments
Using Docker for development
Using Vagrant for development
Access entry-points
Database and Solr credentials
Full config.yml example for Vagrant
Using PHP server for development
Use Mailhog to catch outgoing emails
Manual configuration
DotEnv
Doctrine
Choose your inheritance model
Themes
Cache drivers
Monolog handlers
Solr endpoint
Reverse proxy cache invalidation
Entities paths
Configure mailer
Images processing
Console commands
Additional commands
Upgrading
Moving a website to another server
Moving to a SSH+Git hosting plan or an other development machine
Moving to a non-SSH hosting plan
Install Standard Edition on shared hosting
Prepare your local env with Makefile
Node system
Node-types, nodes-sources and nodes
What is a Node-type
Node-sources and translations
Node-type fields
Simple data
Virtual data
Complex data
Universal fields
YAML field
Many to many and Many to one joins
Single and multiple provider
Custom collection
Handling nodes and their hierarchy
Hierarchy
Visibility
Publication workflow
Generating paths and url
Tag system
Translate tags
Tag hierarchy
Displaying node-source tags with Twig
Tags translations documents
Attributes
Attributes types
Add attributes to nodes
Twig extension
Filters
Tests
Go headless
No more theme, just business logic
Headless structure
Configure CORS
API usage and authentication
Themes
Creating a theme
Preparing your own frontend theme
Static routing
Dynamic routing
Home page case
Using Twig
Checking role permissions
Checking node-sources type
Generating paths and url
Generating assets paths and url
Handling node-sources with Twig
Use node references
Loop over node-source children
Add previous and next links
Additional filters
Create your own Twig filters
Use custom Twig extensions
Displaying documents
HTML output options
Using src-set attribute for responsive images
Generate <picture> elements
More document details
Displaying document metas
Displaying document thumbnails
Manage global documents
Extending your Twig assignation
Use theme-wide assignation
Use
Page / Block
data pattern
Use block rendering
Use controller rendering
Paginate entities using EntityListManager
Alter your Roadiz queries with events
Add a firewall in your theme
Configuring a non-root firewall map entry with FirewallEntry class
Add login routes
Configuring a root firewall map entry with FirewallEntry class
Multi-theme website
Sending emails from your website
Forms
Building contact forms
One contact-form for one action
Using contact-form in
block
controllers
Alter email configuration after form submit
Securing your form with
Google reCAPTCHA
Sending contact form and accept application/json
Building custom forms
Adding custom form to your theme
Services
Entity APIs
Using Solr API
Simple search results
Search results with highlighting
Count search results
Search criteria
Services list
Kernel
Assets
Back-office
Bags
Console
Debug
Doctrine
Embed documents
Entity Api
Factories
Forms
Importers
Logger
Mailer
Routing
Security
Serialization
Solr
Themes
Translation
Twig
Configuration
Workflow
Utils
OpenId
Serialization
Customize existing serialized entities
Serialize nodes-sources URL
Serialize documents URL
Groups
Case studies
Download a website on my computer to work with Vagrant
On the production server:
On your computer:
Contributing
Reporting issues
Running tests
Coding style
Static analysis
Troubleshooting
Empty caches manually for an environment
Problem with entities and Doctrine cache?
Running Roadiz behind a reverse proxy
Find help before posting an issue on Github
Extension system
Extending Roadiz
Theme powered CMS
Create your own database entities
Add back-office entry
Linking things together
Inject your own entries in back-stage
Events
Nodes events
NodesSources events
Tags events
Folders events
Translations events
UrlAlias events
User events
Extending Solr indexation
How to index page blocks contents
Roadiz documentation
Docs
»
Developer documentation
»
Case studies
Edit on GitHub
Case studies
¶
Some step-to-step guides to work with Roadiz.
Download a website on my computer to work with Vagrant
Read the Docs
v: v1.6.5
Versions
latest
stable
v1.7.0
v1.6.5
v1.5.4
v1.4.0
v1.3.1
develop
Downloads
On Read the Docs
Project Home
Builds
Free document hosting provided by
Read the Docs
.