Links Settings

Navigate to the System Settings > Links subsection to see the list of all URLs used at the developer dashboard and email notifications. Here, you can edit these default links to customize your platform.

Below, we’ll overview how to manage a link and provide a full list of URLs used within the dashboard.

Managing Links

You can quickly locate the required link in the list using the Search field in the tools panel (e.g. JELASTIC_COMMUNITY). Expand the record to see details on the URL. Here, based on your needs, different links can be provided for different user groups and different localizations. By default, the link value is provided for all groups and default language.

Below, you’ll find out how to:

• add a link value
• edit the link
• remove the link

Adding Link Value

You can override any default link value by adding more specific criteria (e.g. URL for a particular group will be used over all groups value). Choose the required record and click Add at the tools panel above to provide a new link value.

Within the opened Add Link dialog, you need to specify:

• Group - users' group the link should be displayed for (you can choose all or a specific one: beta, trial, billing, etc.)
• Language - the added link value will be applied only for customers with the specified language (can be default or a specific one)
• Link - a new URL, which can be stated with dynamic parameters that are substituted automatically according to the users data: %(lang), %(session), %(uid), %(email), %(balance), %(status), %(bonus), %(group), %(URL_DASHBOARD)
• Displayed Text - the way this link is going to be displayed for users (optional)

Click OK.

Do not forget to Apply the changes you’ve made via the same-named button in the tools panel.

Editing Link

To edit a link value, double-click the appropriate record or choose it and use the Edit button above the list.

In the opened Edit Link window, you can change the link’s Value and Displayed Text (just Value for the default settings).

Click OK at the bottom of the frame when ready.

Confirm the changes by clicking the Apply button within the tools panel.

Removing Link

To delete a particular URL value, choose it in the list and click the Remove button from the panel above.

Confirm an action via the appeared pop-up.

Links List

This section provides details on all of the provided links. Click on a particular record to get a short overview of the element and its location within the dashboard.

• ACCOUNT_CHANGE_PASSWORD

  If needed, you can provide a link to the external password change service to be used instead of the default implementation. For example, can be used within email templates.

• ACCOUNT_RECOVER_PASSWORD

  If needed, you can provide a link to the external password restoration service to be used instead of the default implementation. For example, can be used within email templates.

• ACCOUNT_SIGNUP

  If needed, you can provide a link to the external account signup service to be used instead of the default implementation. For example, can be used within email templates.

• ACCOUNT_VIEW_INVOICES

  If needed, you can provide a link to the external page with invoices details to be used instead of the default implementation. For example, can be used within email templates.

• BUY_SSL_CERTIFICATE

  Link to the page where a user can buy an SSL certificate.

  Location: Wizard > SSL > Custom SSL > Buy SSL Certificate (availability depends on the UI_BUY_SSL_CERTIFICATE user interface setting).

  

• DOCS_APP_CONFIGURATION

  Link to the documentation on application configuration that is displayed in a pop-up message after creating an environment.

  

• DOCS_AUTO_DISCOUNTS

  Link to the documentation on the automatic discounts on the platform. It is displayed upon hovering over the hint icon for the Save line in the pricing widget at the topology wizard.

  

• DOCS_AUTO_HORIZONTAL_SCALING

  Link to the instruction on setting triggers for automatic horizontal scaling, which is placed within the following locations:

  • environment Settings > Monitoring > Auto Horizontal Scaling subsection
  • pop-up message that appears after creating an environment
• DOCS_BLUE_GREEN_DEPLOY

  Link to the description of the blue-green deployment is located in the archive and Git/SVN deployment frames (in case of deploying to a non-PHP environment).

  

• DOCS_CLI

  Link to the platform command-line interface documentation available via the Help > CLI menu item.

  

• DOCS_COLLABORATION

  This link leads to the documentation about accounts collaboration with the platform. It is used in the following locations:

  • User Settings > Collaboration options
  • environment Settings > Collaboration tab
  • within the first slide of the welcome tutorial
• DOCS_CUSTOM_DOMAINS

  This parameter’s value defines a link to the documentation about domain binding, it is located in the environment Settings > Custom Domains section.

  

• DOCS_CUSTOM_SSL

  Link to the documentation about enabling Custom SSL for your environment.

  Location: Topology Wizard > SSL > Custom SSL > Learn more.

  

• DOCS_DASHBOARD_GUIDE

  This link leads to the Dashboard Guide documentation page. It is used within the first slide of the welcome tutorial.

  

• DOCS_DEPLOYMENT_GUIDE

  Link to the deployment guide that is displayed in a pop-up message after creating an environment.

  

• DOCS_DEPLOYMENT_HOOKS

  Link to the deployment hooks documentation. Located within the Edit (Pre-) Post-Deployment Hook frames accessible from the archive and Git/SVN deployment dialogs.

  

• DOCS_DOCKER_CONFIG

  Link to the guide on the basic Docker container configuration, displayed at the Search tab within the Docker section of topology wizard.

  

  Also, is shown in the notification after environment with custom Docker containers creation.

  

• DOCS_DOCKER_CREATE

  Link to the instruction on managing your containers, which is displayed at the Search tab within the Docker section of topology wizard.

  

• DOCS_DOCKER_ENV_VARS

  Link to the instruction on container environment variable management, which is located in the appropriate Variables layer settings section (can be accessed through topology wizard or using the Additionally list for a particular layer in environments list).

  

• DOCS_DOCKER_KUBERNETES

  This link leads to the Managed Kubernetes Hosting page. It is used within the first slide of the welcome tutorial.

  

• DOCS_DOCKER_LINKS

  Link to the instruction on containers' linking, which is located in the appropriate Links layer settings section (can be accessed through topology wizard or using the Additionally list for a particular layer in environments list).

  

• DOCS_DOCKER_PORTS

  Link to the documentation on the ports opened in containers, which is located in the appropriate Ports layer settings section (can be accessed through topology wizard or using the Additionally list for a particular layer in environments list).

  

• DOCS_DOCKER_REDEPLOY

  Link to the documentation on container redeploy process, which is displayed at the Search tab within the Docker section of topology wizard.

  

  The same link is shown at the Redeploy frame.

  

  Also, is shown in the notification after environment with custom Docker containers creation.

  

• DOCS_DOCKER_RUN_ARGS

  Link to the instruction on setting custom startup files for containers, which is located in the appropriate CMD / Entry Point layer settings section (can be accessed through topology wizard or using the Additionally list for a particular layer in environments list).

  

• DOCS_DOCKER_SSH_ACCESS

  Link to the instruction on accessing Docker container via SSH, which is displayed in the notification after environment with custom Docker containers creation.

  

• DOCS_DOCKER_USER_DEFINED

  Link to the guidance on custom Docker registries management. It’s located at the Custom tab within the Docker section of the topology wizard.

  

• DOCS_DOCKER_VOLUMES

  Link to the instruction on defining volumes for containers, which is located in the appropriate Volumes layer settings section (can be accessed through topology wizard or using the Additionally list for a particular layer in environments list).

  

• DOCS_ENV_ALERTS

  Link to the documentation about setting and managing Load Alert notifications. The link is located in the following sections:

  • environment Settings > Monitoring > Load Alerts tab
  • pop-up message after creating an environment
• DOCS_ENV_ALERTS_EDIT

  Provides a link to documentation on editing Load Alerts. It is not used within the dashboard by default but can be used within email templates.

• DOCS_ENV_ENDPOINTS

  Defines a link to documentation about attaching endpoints to containers; is displayed at the environment Settings > Endpoints section.

  

• DOCS_ENV_EXPORT

  Link to the instruction on environment export feature, which is displayed at the environment Settings > Export tab.

  

• DOCS_ENV_EXPORTS

  Link to the documentation on exporting data from a container. It appears in the Exports tab of the configuration file manager.

  

• DOCS_ENV_FIREWALL

  Link to the container firewall documentation, which is displayed at the environment Settings > Firewall tab.

  

• DOCS_ENV_IMPORT

  Link to the instruction on the import feature, which is displayed at the Import frame.

  

• DOCS_ENV_MIGRATION

  Link to the instruction on environment migration feature, which is displayed at the environment Settings > Migration tab.

  

• DOCS_ENV_MIGRATION_LIVE

  Link to the documentation on environment live migration feature, which is displayed at the environment Settings > Migration tab (within tooltip for the corresponding option).

  

• DOCS_ENV_MOUNTS

  Link to the documentation about mount points; located at the Mount Points > Add Mount Point tab of the configuration file manager.

  

• DOCS_ENV_REGIONS

  Link to the documentation on choosing the environment region, located at the Regions tab within the Quotas & Pricing frame.

  

• DOCS_ENV_TRANSFER

  Link to the instruction on environment transferring, which is displayed at the environment Settings > Change Owner tab.

  

• DOCS_FTP

  Link to the instruction on FTP-addon usage, which is shown at the appropriate installation frame and gives users some details on operating with nodes via FTP and FTPS protocols.

  

• DOCS_GIT_SSH

  This link is shown in the User Settings > SSH Keys > Private Keys tab and leads to the guide on connecting to the remote GIT repository by means of the SSH keypair.

  

• DOCS_HORIZONTAL_SCALING

  Link to documentation on the horizontal scaling, which is displayed in the topology wizard tooltip.

  

• DOCS_MANAGE_LIFECYCLE

  Provides a link to documentation on Managing Application Lifecycle. It is not used within the dashboard by default (since the PaaS 5.7.7 release) but can be used within email templates.

• DOCS_MARKETPLACE

  Link to the Marketplace documentation, which is displayed within the first slide of the welcome tutorial.

  

• DOCS_MOUNT_TYPE_CONTAINER

  Link to the documentation on creating a dedicated storage container, which is displayed in the Data Container tab of the Mount Points > Add Mount Point section of the configuration file manager.

  

• DOCS_MOUNT_TYPE_EXTERNAL

  Link to the documentation on external NFS storage, which is displayed in the External Server tab of the Mount Points > Add Mount Point section of the configuration file manager.

  

• DOCS_MOUNT_TYPE_MASTER

  Link to the documentation on storing data in the master container, which is displayed in the Master Container tab of the Mount Points > Add Mount Point section of the configuration file manager.

  

• DOCS_MOUNT_TYPE_NO_MOUNT

  Link to the instruction on storing data in local filesystem, which is displayed while adding a new volume in the appropriate Volumes layer settings section (can be accessed through topology wizard or using the Additionally list for a particular layer in environments list).

  

• DOCS_MULTI_REGION

  Link to the multi-region platform structure overview, which is displayed within the first slide of the welcome tutorial.

  

• DOCS_NEW_HN_GROUP

  Provides a link to documentation on a new Host Group Addition. It is not used within the dashboard by default but can be used within email templates.

• DOCS_PAY_AS_USE_MODEL

  This link leads to the Pay As You Use Cloud Pricing page. It is used within the first slide of the welcome tutorial.

  

• DOCS_PRICING_MODEL

  Link to the pricing guide, which is used in the environment topology wizard.

  

• DOCS_PUBLIC_IP

  A link to the public IP description, used in the appropriate Ports layer settings section (can be accessed through topology wizard or using the Additionally list for a particular layer in environments list).

  

• DOCS_RDP_ACCESS

  Link to the instruction on establishing remote desktop connection to the Windows-based containers. To find it at the dashboard, expand the Remote Desktop list for any Windows node and click Info. The link will be displayed in the opened frame, similar to the one below:

  

• DOCS_REFILL_ACCOUNT

  Provides a link to documentation on Account Refill. It is not used within the dashboard by default but can be used within email templates.

• DOCS_SESSION_REPLICATION

  Link to the documentation about session replication. It’s placed in the topology wizard, on the High-Availability option switcher.

  

• DOCS_SHARED_LOAD_BALANCER

  Documentation on the platform Shared Load Balancer, link is located within Built-In SSL description in topology wizard.

  

• DOCS_SMART_LOAD_BALANCING

  This link leads to the Out-of-the-Box Balancing page. It is used within the first slide of the welcome tutorial.

  

• DOCS_SOFT_STACK

  Provides a link to documentation on Software Stacks utilized on the platform. It is not used within the dashboard by default (since the PaaS 5.7.7 release) but can be used within email templates.

• DOCS_SSH_ACCESS

  Link to the user’s documentation about accessing nodes via the SSH Gateway. It is displayed in the following sections:

  • User Settings > SSH Keys > Public Keys
  • User Settings > SSH Access > SSH Connection
  • displayed at the Search tab within the Docker section of the topology wizard
• DOCS_SSH_COMMAND_ADD_NODE

  Link to the documentation on a new host addition via SSH command, located in the appropriate Add Host (SSH Command) frame at the admin panel.

  

• DOCS_SSH_CONTAINER_TOOLS

  URL to the documentation on executing scripts at the remote servers, located within the User Settings > SSH Access > SSH Connection section.

  

• DOCS_SSH_FILE_TRANSFER

  Documentation on file management via secure protocols, located within the SFTP / Direct SSH Access tabs in User Settings, configuration file manager, etc.

  

• DOCS_SSH_GATEWAY

  Provides a link to documentation on accessing VPS via the SSH Gate. It is not used within the dashboard by default but can be used within email templates.

• DOCS_SSH_OVERVIEW

  Provides a link to documentation on the container access via SSH Gate. It is not used within the dashboard by default (since the PaaS 5.7.7 release) but can be used within email templates.

• DOCS_SSL

  Link to the documentation about enabling Built-In SSL, located within Built-In SSL description in topology wizard.

  

• DOCS_TWO_FACTOR_AUTH

  Link to the documentation on two-factor authentication, can be found within the User Settings > Account section (in case 2FA is configured on the platform).

  

• DOCS_USER_ACCESS_TOKENS

  Link to the documentation on personal access tokens, can be found within User Settings > Access Tokens section.

  

• DOCS_VERTICAL_SCALING

  Link to the vertical scaling feature description, which is displayed within the first slide of the welcome tutorial.

  

• DOCS_WINDOWS_RDP_ACCESS

  Link to the documentation on the remote desktop access to the Windows-based node. It can be seen in the dashboard notification after installing Windows node.

  

• DOCS_WINDOWS_SERVER_FEATURES

  Link to the documentation on managing Windows Server. It is displayed in the dashboard notification after installing Windows node.

  

• DOCS_WIN_DEPLOY

  This link is placed at the Publish Info > Info frame for the IIS node and provides a user with the information on the .NET projects deployment.

  

• DOCS_ZDT_DEPLOY

  Link to the description of ZDT-deployment, located next to the corresponding check-box in the archive and Git/SVN deployment frames (if deploying to the PHP environment).

  

• DOCS_ZERO_CODE_CHANGES

  This link leads to the Deployment with Zero Code Change article. It is used within the first slide of the welcome tutorial.

  

• EXTERNAL_BILLING_PANEL

  If needed, you can provide a link to the external billing panel. For example, can be used within email templates.

• HOSTER_POLICY

  Link to the platform Privacy Policy. It is located on the sign-up frame.

  

• HOSTER_PRICING

  Link to the platform’s pricing page, located at the Upgrade Account > Learn about Pricing menu item (for trial users).

  

• HOSTER_SITE

  Link to the platform homepage. The redirect is located on the logo at the top-left corner of the dashboard.

  

• HOSTER_SUPPORT

  Link to the platform support page - Help > Contact Support menu item in the dashboard (for billing users).

  

  The value of this parameter can be started with mailto: to redirect users to the form, which can be filled in and sent as an email notification to the support team.

• HOSTER_TERMS

  Link to the platform Terms of Service. It is located on the sign-up frame.

  

• HOSTER_TRIAL_SUPPORT

  Link to the platform support page - Help > Contact Support menu item in the dashboard (for trial users).

  

  The value of this parameter can be started with mailto: to redirect users to the form, which can be filled in and sent as an email notification to the support team.

• JPS_REPOSITORY

  Link to JPS Collection on GitHub that appears twice in the Import dialog box.

  

• PLATFORM_API_DOCS

  Link to the API documentation - Help > API menu item in the dashboard.

• PLATFORM_API_DOCS_DETAILED

  Placeholder which builds a direct link to a particular API method.

• PLATFORM_COMMUNITY

  Link, that leads to the PaaS Community from the dashboard. It is located at the Go to Community button at:

  • login form
  • Help menu item in the dashboard
• PLATFORM_DOCS

  Link to the documentation - Help > Documentation menu item in the dashboard.

  

• PLATFORM_TRACKING_PIXEL

  Link to the pixel image, which is required for tracking.

• PLATFORM_VIDEOS

  Link to the platform YouTube Channel - Help > Video menu item in the dashboard.

  

• PREMIUM_SUPPORT

  Link to an external page with premium support offers. Can be found within the Help menu, under the Get Premium Support option. By default, this option is displayed for the Lite Edition platforms only.

  

• REFILL_ACCOUNT

  If needed, you can provide a link to the external page for refilling the account balance. This parameter is not used by platforms with PBA/PBAS billing systems. For example, can be used within email templates.

• UPGRADE_ACCOUNT

  If needed, you can provide a link to the external page for converting the account. This parameter is not used by platforms with PBAS billing systems. For example, can be used within email templates.

• VIDEO_PRICING_MODEL

  Link to more info about pricing, which is displayed in a tooltip that appears upon hovering over the price in the topology wizard.

  

What’s next?

• Access Control
• System Settings Overview
• User Interface Settings
• Localization