Environment Switcher Application
 | Allow users to switch from a wiki page to the same exact page in another environment, for example switching from staging environment to production. |
| Type | XAR |
| Category | Application |
| Developed by | |
| Rating | |
| License | GNU Lesser General Public License 2.1 |
Table of contents
Description
This extension is useful when working on a project with multiple environments (dev, staging, production, …), it can be interesting to have the possibility to switch from a wiki page in production to the same exact page in dev, or on staging. The app adds a UIX that allows switching from one instance to another.
See screenshot:
Environment switcher UI
Configuration
The Environment Switcher Application can be configured in the wiki administration, in the "Environment Switcher" section. These are the options that can be configured:
- Environments : In order to add environment configurations edit the page EnvironmentSwitcherCode.EnvironmentSwitcherConfiguration using object editor and attach to it objects of class EnvironmentSwitcherCode.EnvironmentClass. For each object of class EnvironmentClass fill the environment Name and URL properties.
- Viewers : Select the group of users that are allowed to use the application.
See screenshot:
Environment switcher configuration
Translations
The translations of the environment switcher application can be found on this page: EnvironmentSwitcherCode.Translations.
Prerequisites & Installation Instructions
We recommend using the Extension Manager to install this extension (Make sure that the text "Installable with the Extension Manager" is displayed at the top right location on this page to know if this extension can be installed with the Extension Manager). Note that installing Extensions when being offline is currently not supported and you'd need to use some complex manual method.
You can also use the following manual method, which is useful if this extension cannot be installed with the Extension Manager or if you're using an old version of XWiki that doesn't have the Extension Manager:
- Log in the wiki with a user having Administration rights
- Go to the Administration page and select the Import category
- Follow the on-screen instructions to upload the downloaded XAR
- Click on the uploaded XAR and follow the instructions
- You'll also need to install all dependent Extensions that are not already installed in your wiki
Release Notes
v1.0.1
Fix the issue tracker and EM category on the pom.xml file.
