--- title: "Website" description: "Pages and forms. Hold the content of a public website: pages, menus, blog posts and the form submissions visitors send." canonical: "https://obop.dev/apps/website/" lang: "en" --- # Website ## What it is for Hold the content of a public website: pages, menus, blog posts and the form submissions visitors send. This app stores and organises content; something else renders it. Publishing needs approval. ## What the package does and does not do Content for a public website: pages with a slug and a draft, published, archived flow, navigation menu items, blog posts with a byline and a publish date, translations of both, and the form submissions visitors send in. When the instance runs with the public site enabled it serves the published content to visitors as a server-rendered website with SEO and no login; only the fields marked public are ever visible to them. Publishing makes content public and needs a human approval, agents may only propose it. Senders are personal data and are never public. ## Models ### `website_page` A page of the website Read group: `website.user`. Write group: `website.user`. | Field | Kind | Data class | Personal data | Group | Agents see | Description | |---|---|---|---|---|---|---| | `title` | text | `none` | no | `website.user` | in clear | Page title | | `slug` | text | `none` | no | `website.user` | in clear | URL path of the page without slashes at the ends, lowercase with dashes, for example about-us. The page with slug home is the front page | | `body` | longtext | `none` | no | `website.user` | in clear | Page content in Markdown (a safe subset: headings, lists, links, emphasis, code, quotes, tables) | | `seo_title` | text | `none` | no | `website.user` | in clear | Title shown in search results; empty means the page title | | `seo_description` | text | `none` | no | `website.user` | in clear | Description shown in search results | | `published_on` | date | `none` | no | `website.user` | in clear | Day the page went public (YYYY-MM-DD) | | `state` | select (draft, published, archived) | `none` | no | `website.user` | in clear | Page status: draft, published, archived | ### `website_menu_item` An entry of the site navigation Read group: `website.user`. Write group: `website.manager`. | Field | Kind | Data class | Personal data | Group | Agents see | Description | |---|---|---|---|---|---|---| | `label` | text | `none` | no | `website.user` | in clear | Text shown in the menu | | `url` | text | `none` | no | `website.user` | in clear | Where the entry leads: a page slug starting with a slash or a full address | | `parent_id` | ref → website_menu_item | `none` | no | `website.user` | in clear | The entry this one is nested under; empty for a top-level entry | | `sequence` | number | `none` | no | `website.user` | in clear | Order among its siblings, lowest first | | `visible` | bool | `none` | no | `website.user` | in clear | Whether the entry is shown | | `new_window` | bool | `none` | no | `website.user` | in clear | Whether the link opens in a new window | ### `website_blog_post` A blog post Read group: `website.user`. Write group: `website.user`. | Field | Kind | Data class | Personal data | Group | Agents see | Description | |---|---|---|---|---|---|---| | `title` | text | `none` | no | `website.user` | in clear | Post title | | `slug` | text | `none` | no | `website.user` | in clear | URL part of the post, lowercase with dashes | | `author_name` | text | `public_directory` | yes | `website.user` | masked | Name of the author, for the team's own records | | `byline` | text | `none` | no | `website.user` | in clear | Author line shown publicly, for example the team or brand name; use a name here only if the person agreed to it | | `summary` | text | `none` | no | `website.user` | in clear | Teaser shown in listings | | `body` | longtext | `none` | no | `website.user` | in clear | Post content in Markdown (a safe subset: headings, lists, links, emphasis, code, quotes, tables) | | `tags` | text | `none` | no | `website.user` | in clear | Comma-separated tags, for example news,product | | `published_on` | date | `none` | no | `website.user` | in clear | Day the post is dated (YYYY-MM-DD) | | `state` | select (draft, published, archived) | `none` | no | `website.user` | in clear | Post status: draft, published, archived | ### `website_form_submission` A message a visitor sent through a form on the site Read group: `website.user`. Write group: `website.user`. | Field | Kind | Data class | Personal data | Group | Agents see | Description | |---|---|---|---|---|---|---| | `form_name` | text | `none` | no | `website.user` | in clear | Which form it came from, for example contact | | `sender_name` | text | `internal` | yes | `website.user` | masked | Name the visitor gave | | `sender_email` | text | `internal` | yes | `website.user` | masked | Email address the visitor gave | | `sender_phone` | text | `internal` | yes | `website.user` | masked | Phone number the visitor gave | | `message` | longtext | `internal` | yes | `website.user` | masked | What the visitor wrote | | `source_page` | text | `none` | no | `website.user` | in clear | Slug of the page the form was on | | `submitted_on` | date | `none` | no | `website.user` | in clear | Day of the submission (YYYY-MM-DD) | | `consent_given` | bool | `none` | no | `website.user` | in clear | Whether the visitor ticked the consent box for being contacted | | `state` | select (new, handled, spam) | `none` | no | `website.user` | in clear | Handling status: new, handled, spam | ### `website_page_translation` A page translated into another language; the public site shows it to visitors who read that language Read group: `website.user`. Write group: `website.user`. | Field | Kind | Data class | Personal data | Group | Agents see | Description | |---|---|---|---|---|---|---| | `page_id` | ref → website_page | `none` | no | `website.user` | in clear | The page this translates | | `lang` | select (en, de, fr, pl, fi, sv, es) | `none` | no | `website.user` | in clear | Language of the translation: en, de, fr, pl, fi, sv or es | | `title` | text | `none` | no | `website.user` | in clear | Translated page title | | `body` | longtext | `none` | no | `website.user` | in clear | Translated page content in Markdown | | `seo_title` | text | `none` | no | `website.user` | in clear | Translated title shown in search results | | `seo_description` | text | `none` | no | `website.user` | in clear | Translated description shown in search results | | `published` | bool | `none` | no | `website.user` | in clear | Whether the translation is shown; it is only reachable while its page is published | ### `website_blog_post_translation` A blog post translated into another language Read group: `website.user`. Write group: `website.user`. | Field | Kind | Data class | Personal data | Group | Agents see | Description | |---|---|---|---|---|---|---| | `post_id` | ref → website_blog_post | `none` | no | `website.user` | in clear | The post this translates | | `lang` | select (en, de, fr, pl, fi, sv, es) | `none` | no | `website.user` | in clear | Language of the translation: en, de, fr, pl, fi, sv or es | | `title` | text | `none` | no | `website.user` | in clear | Translated post title | | `summary` | text | `none` | no | `website.user` | in clear | Translated teaser | | `body` | longtext | `none` | no | `website.user` | in clear | Translated post content in Markdown | | `published` | bool | `none` | no | `website.user` | in clear | Whether the translation is shown; it is only reachable while its post is published | ## Workflows ### `website_page` | Action | Moves | Who may run it | Approval | |---|---|---|---| | `website_page.publish` | state: draft → published | `website.manager` | yes | | `website_page.unpublish` | state: published → draft | `website.manager` | no | | `website_page.archive` | state: published → archived | `website.manager` | no | ### `website_blog_post` | Action | Moves | Who may run it | Approval | |---|---|---|---| | `website_blog_post.publish` | state: draft → published | `website.manager` | yes | | `website_blog_post.unpublish` | state: published → draft | `website.manager` | no | | `website_blog_post.archive` | state: published → archived | `website.manager` | no | ### `website_form_submission` | Action | Moves | Who may run it | Approval | |---|---|---|---| | `website_form_submission.handle` | state: new → handled | `website.user` | no | | `website_form_submission.mark_spam` | state: new → spam | `website.user` | no | ## Permission groups Groups used by this app: - `website.manager` - `website.user` ## Approval steps Steps an agent can only propose: - `website_page.publish` - `website_blog_post.publish` ## What agents can and cannot do An agent can read, search, create and update records of this app, and run the actions that need no approval, within the permission groups of its token. It can only propose these steps, and a person must approve them: `website_page.publish`, `website_blog_post.publish`, `website_page.delete`, `website_menu_item.delete`, `website_blog_post.delete`, `website_form_submission.delete`, `website_page_translation.delete`, `website_blog_post_translation.delete`. Personal data is masked as placeholder tokens: `website_blog_post.author_name`, `website_form_submission.sender_name`, `website_form_submission.sender_email`, `website_form_submission.sender_phone`, `website_form_submission.message`. ## Dependencies None. ## Install Install it from the Customize app (Marketplace), or from the command line: ```bash obop modules install-from website ``` Needs a database and administrator rights. ## Build your own [The module guide shows how apps like this one are written](/docs/reference/module-manifest/)