Prerequisites

• Python 3.10 or higher

• Kotti2 >= 3.0.0

Install from PyPI

pip install kotti-iframe

Install from Source

git clone https://gitcode.com/skywalk163/kotti-iframe.git
cd kotti-iframe
pip install -e .

Basic Configuration

Add the configurator to your INI file:

kotti.configurators =
    kotti_iframe.kotti_configure

This will:

• Register the IframeContent type

• Add it to the list of addable content types

• Configure the database migrations

Full Example Configuration

Here’s a complete development.ini example:

[app:kotti_iframe]
use = egg:kotti

pyramid.reload_templates = true
pyramid.debug_templates = true
pyramid.includes =
    pyramid_debugtoolbar
    pyramid_tm

sqlalchemy.url = sqlite:///%(here)s/kotti_iframe.db

kotti.configurators =
    kotti_iframe.kotti_configure
kotti.site_title = My Kotti Site
kotti.secret = your-secret-password-here

[server:main]
use = egg:waitress#main
port = 5001

For a Fresh Installation

If you’re starting with a new database, run:

python init_db.py development.ini

This will:

1. Create all necessary database tables

2. Create the root Document

3. Create the admin user

For Existing Kotti Installations

If you already have a Kotti database, run the migration:

alembic -c development.ini upgrade head

Adding Iframe Content

1. Log in to your Kotti site as admin

2. Navigate to the Document where you want to add the iframe

3. Click the “Add” button in the editor bar

4. Select “Iframe Content” from the dropdown

5. Fill in the form:

   • Title: Display title for the iframe

   • Description: Optional description

   • Iframe URL: The URL to embed (required)

   • External URL: Link to open in new tab (defaults to iframe URL)

   • Width: CSS width value (default: “100%”)

   • Height: CSS height value (default: “600px”)

   • Allow Fullscreen: Enable fullscreen mode (default: yes)

   • Show External Link: Show “Open in New Tab” button (default: yes)

   • Container CSS Class: Additional CSS classes for styling

6. Click “Save”

Viewing Iframe Content

• Default View: Shows the iframe with title, description, and optional external link button

• Embed View: Access via /embed URL for minimal display (just the iframe)

Custom Sandbox Attributes

You can customize sandbox restrictions by setting the sandbox_attributes field when creating or editing IframeContent. For example:

["allow-scripts", "allow-forms"]

This would allow scripts and forms, but block same-origin access and popups.

For maximum security when embedding untrusted content:

[]

This applies the most restrictive sandbox (no permissions).

Running Tests

pip install -e ".[testing]"
pytest kotti_iframe/tests/

Building the Package

python -m build

Contributing

Contributions are welcome! Please submit pull requests or issues at: https://gitcode.com/skywalk163/kotti-iframe