Dashboard
The Dashboard displays an overview of a user’s pages, files and images as well as a button to clear any previously stored UI configuration.
You have been redirected from an outdated version of the article. Below is the content available on this topic. To view the old article click here.
The Dashboard displays an overview of a user’s pages, files and images as well as a button to clear any previously stored UI configuration.
application.releases.index.url | Contains a URL that is used by the Structr UI to determine the list of available releases to show on the dashboard. |
application.snapshots.index.url | Contains a URL that is used by the Structr UI to determine the list of available snapshots to show on the dashboard. |
application.title | The title of the application as shown in the log file. This entry exists for historical reasons and has no functional impact other than appearing in the log file. |
application.instance.name | The name of this application. In this setting, you can set a string that will be show in the top right corner of the Structr UI. |
application.instance.stage | The “stage” of the application. In this setting, you can set a string that will be show in the top right corner of the Structr UI together with the instance name. |
application.menu.main | This setting controls the order and visibility of elements of the Structr main menu. |
application.console.cypher.maxresults | The maximum number of results returned by a cypher query in the admin console. If a query yields more results, an error message is shown. |
application.systeminfo.disabled | Disables transmission of telemetry information. This information is used to improve the software and to better adapt to different hardware configurations. |
application.legacy.requestparameters.enabled | Enables pre-4.0 request parameter names (sort, page, pageSize, etc. instead of _sort, _page, _pageSize, …) |
Creates a Deployment Export or Import of the application. This command reads or writes a text-based export of the application (without its data!) that can be stored in a version control system. The maintenance command is used internally in the Dashboard section.
Instead of creating users in the Structr backend manually in the Users and Groups section of Structr’s admin UI, you can allow users to sign-up/self-register. The registration process uses double-opt in by default. All you need is a simple page where new users can enter their e-mail address so Structr can send them an e-mail with a confirmation link.
The following pre-defined MailTemplate keys can be used to configure the self-registration process. In version 4.0 they have been renamed to have a more uniform structure.
Note: The Mail Configuration Settings have to be done for self-registration mails to be sent.
Name | Old Name (removed as of v4.1) | Used as | Default |
---|---|---|---|
CONFIRM_REGISTRATION_SENDER_ADDRESS | SENDER_ADDRESS | The sender address of the registration mail | structr-mail-daemon@localhost |
CONFIRM_REGISTRATION_SENDER_NAME | SENDER_NAME | The sender name of the registration mail | Structr Mail Daemon |
CONFIRM_REGISTRATION_SUBJECT | SUBJECT | The subject of the registration mail | Welcome to Structr, please finalize registration |
CONFIRM_REGISTRATION_TEXT_BODY | TEXT_BODY | The plaintext body of the registration mail | Go to ${link} to finalize registration. |
CONFIRM_REGISTRATION_HTML_BODY | HTML_BODY | The HTML body of the registration mail | <div>Click <a href='${link}'>here</a> to finalize registration.</div> |
CONFIRM_REGISTRATION_BASE_URL | BASE_URL | Used to build the link variable | ${base_url} |
CONFIRM_REGISTRATION_TARGET_PAGE | TARGET_PAGE | the target parameter value for the redirection target page name | register_thanks |
CONFIRM_REGISTRATION_ERROR_PAGE | ERROR_PAGE | the error parameter value for the error redirection target page name | register_error |
Notes:
link
variable is provided for the TEXT_BODY
and HTML_BODY
templates and can be output with the usual syntax: ${link}
link
: https://support.structr.com/confirm_registration?key=<CONFIRM_KEY>&target=/dashboard&onerror=/register-error
CONFIRM_REGISTRATION_TEXT_BODY
and CONFIRM_REGISTRATION_TEXT_BODY
. The script is being run in the context of the user (me keyword points to the user).Go to the ‘Dashboard’ section of the Structr UI into the tab Deployment
. Enter the data path as an absolute path of the local file system into the input field Import data from local directory
and click on the button.
Go to the ‘Dashboard’ section of the Structr UI into the tab Deployment
. Enter the export location as an absolute path of the local file system into the input field Export application to local directory
and click on the button.
If you want to export your Structr application to a remote target system you can do so by clicking the button Export and download application as ZIP file
in the ‘Dashboard’ section of the Structr UI under the tab Deployment
.
Go to the ‘Dashboard’ section of the Structr UI into the tab Deployment
. Enter the application’s path as an absolute path of the local file system into the input field Import application from local directory
and click on the button.
If you want to import an Structr application from a remote system you can put the source code of the exported application into a ZIP file on a remote location. Enter that location into the field Import application from URL
in the ‘Dashboard’ section of the Structr UI under the tab Deployment
and click on the button to start the download and import process.
If there are a lot of grants to configure it is advisable to active the switch “Show visibility flags in Resource Access Grants table” on the “UI Settings” tab on the dashboard.
Go to the ‘Dashboard’ section of the Structr UI into the tab Deployment
. Enter the export location as an absolute path of the local file system into the input field ‘Export data to local directory’, select the desired export types and click on the Export button.
Warning: The application.menu.main setting is deprecated as of versions 3.5. The usage of the UI Settings tab on the dashboard is encouraged instead.