[Redirect]https://help.themehouse.com/docs/install-and-upgrade/getting-started-with-install-and-upgrade/[/Redirect]

Thank you for your interest in Install and Upgrade! Here you will find documentation for Installing Install & Upgrade, Setting Up Profiles, Add-ons, Styles, Languages, Install and Upgrade log, Permission, and For Developers. If you need something specifically explained, please feel free to get in touch. Installing and upgrading your themes, add-ons and languages on your site just got easier with Install & Upgrade. Simplify your upgrades and installations with just a few clicks and reduce the management of updates by automatically checking for updates with our tool. Start simplifying your processes now.

This is not compatible with XenForo 2.0. Your first step is to download the add-on from your customer area. You will be asked to provide some information before downloading. Once you download, save the .zip file somewhere you are familiar with. Next, you will want to extract the files. After that is done you will need to upload the contents inside the upload folder into your root Xenforo directory. After you have uploaded the files you will need to navigate to the Add-ons section within your XenForo admin panel. Here you will see it listed under "Installable add-ons". Just click Install! Go into src and download your configuration file. Add $config['enableAddOnArchiveInstaller'] = true; to the end of the configuration file, save and re-upload it. Congratulations! You have officially installed the Install & Upgrade add-on on your site. ZIP Upload (XenForo 2.1. and higher) Your first step is to download the add-on from your customer area. You will be asked to provide some information before downloading. Once you download, save the .zip file somewhere you are familiar with. After you have downloaded the file, you will need to navigate to the Add-ons section within your XenForo admin panel. Click “Install/upgrade from archive” and follow the on screen instructions. When asked for an add-on archive, select the previously downloaded file. Congratulations! You have officially installed the Install & Upgrade add-on on your site.

After installing Install & Upgrade, you will need to set up profiles for any provider you like to use. To set up a new profile, navigate to ACP -> Setup -> Service Providers -> Install & Upgrade profiles and click “Add profile”. We currently ship the following service providers with Install & Upgrade: ThemeHouse This profile is responsible for your ThemeHouse add-ons and styles. API Key You may obtain your ThemeHouse API key in your customer area on ThemeHouse. Navigate to your account dashboard -> Account -> API -> Generate an API key before copying it. XenForo 2 Resource Manager This profile is responsible for the specified XenForo resource manager. You may use it to connect to the XenForo Resource Manager or any 3rd party site that runs a XenForo 2 resource manager. Resource Manager base url The URL of this resource manager’s installation. Please be aware that the resource manager of this page has to be accessible via (URL)/resources, otherwise Install & Upgrade won’t know where to download your resources from. Page title The name of the page. Email or username The username or email address you use to log into the above entered site. Password The password you use to log into the above entered site. The password is stored in your database in an encrypted form (with the encryption secret used below). It will not be exposed to anyone after encryption and is only ever temporarily encrypted for Install & Upgrade. Has two-factor authentication This option must be enabled if your account entered above is protected by two-factor authentication. Install & Upgrade will prompt you for your two-factor code whenever required. Encryption secret This is your on-site password used by Install & Upgrade to encrypt your actual site password entered above. You can use this to provide other administrators with the ability to use Install & Upgrade without exposing your actual password for this site to them. If you lose your encryption secret, you will need to edit this profile and re-enter your actual password, so Install & Upgrade can re-encrypt it with a new encryption secret. Dragonbyte This profile is responsible for your Dragonbyte add-ons. API Key You may obtain your Dragonbyte API key in your customer area on Dragonbyte. To grab your API key click on the “View API Key” button at the top-right of the page. Atelier Aphelion This profile is responsible for your Atelier Aphelion add-ons. API Key You may obtain your Dragonbyte API key in your customer area on Dragonbyte. To grab your API key click on the “View API Key” button at the top-right of the page.

All Install & Upgrade add-on functions are available from ACP -> Add-ons -> Add-ons. Installing a new add-on via product list Install & Upgrade automatically obtains a list of available products from all profiles that support it. When clicking “Install & Upgrade”, the first opened tab will be “Install from available products”. If the tab is not shown, you do not have any eligible products. Select one or more add-ons you like from the list of available products, and hit “Install”. Install & Upgrade will guide you through the rest of the installation automatically. Installing a new add-on via URL Click “Install & Upgrade” and then “Install/upgrade from URL”. Paste any number of URLs you want to install from into the list and click “Download”. Install & Upgrade will guide you through the rest of the installation automatically. You may install multiple add-ons via URL at a time, but all of them have to be from the same provider. If you want to install from multiple providers, you need to do it in multiple steps. Installing a new add-on via ZIP Click “Install & Upgrade” and then “Install/upgrade from archive”. Select any number of add-on archives you want to install click “Upload”. Install & Upgrade will guide you through the rest of the installation automatically. Add-ons installed via ZIP will not receive automated update checks. Retrospectively linking already installed add-ons Simply reinstall any add-on you want to link that are already installed either via the product list or URL method as described above. Install & Upgrade will automatically create the respective links for you. Upgrading add-ons If Install & Upgrade detects an available update: Add-ons that are able to be upgraded can be found under ACP -> Add-ons -> Add-ons -> Upgradeable add-ons. When you are ready to update, choose “Upgrade” next to the add-on. If the add-on needs to be added manually: To manually update add-ons, go to ACP -> Add-ons -> Add-ons -> Click "Install & Upgrade" before selecting the add-on you want to upgrade. If there is an upgrade it will show you "Upgrade" on the next page. When you are ready to update, press the button that says "Upgrade".

All Install & Upgrade style functions are available from ACP -> Appearance -> Styles. Installing a new style via product list Install & Upgrade automatically obtains a list of available products from all profiles that support it. When clicking “Install & Upgrade”, the first opened tab will be “Install from available products”. If the tab is not shown, you do not have any eligible products. Select a style you like from the list of available products, and hit “Install”. Install & Upgrade will guide you through the rest of the installation automatically. Installing a new style via URL Click “Install & Upgrade” and then “Install/upgrade from URL”. Paste the URL you want to install from into the list, choose how to import it as, and click “Download”. Install & Upgrade will guide you through the rest of the installation automatically. Installing a new style via XML Click “Install & Upgrade” and then “Install/upgrade from xml”. Select the style xml you want to install, choose how to import it as, and click “Import”. Install & Upgrade will guide you through the rest of the installation automatically. Styles installed via xml will not receive automated update checks. Retrospectively linking already installed styles You may link existing styles with Install & Upgrade by re-installing them via product list or URL as described above and selecting the existing style as overwrite target. Upgrading styles Styles that are able to be upgraded can be found under ACP -> Appearance -> Styles -> Upgradeable styles. When you are ready to upgrade, choose “Upgrade” next to the style. The list of upgradeable styles is only shown when an update has been found.

All Install & Upgrade style functions are available from ACP -> Appearance -> Languages. Installing a new language via product list Install & Upgrade automatically obtains a list of available products from all profiles that support it. When clicking “Install & Upgrade”, the first opened tab will be “Install from available products”. If the tab is not shown, you do not have any eligible products. Select a language you like from the list of available products, and hit “Install”. Install & Upgrade will guide you through the rest of the installation automatically. Installing a new language via URL Click “Install & Upgrade” and then “Install/upgrade from URL”. Paste the URL you want to install from into the list, choose how to import it as, and click “Download”. Install & Upgrade will guide you through the rest of the installation automatically. Installing a new style via XML Click “Install & Upgrade” and then “Install/upgrade from xml”. Select the style xml you want to install, choose how to import it as, and click “Import”. Install & Upgrade will guide you through the rest of the installation automatically. Languages installed via xml will not receive automated update checks. Retrospectively linking already installed languages You may link existing languages with Install & Upgrade by re-installing them via product list or URL as described above and selecting the existing language as overwrite target. Upgrading languages Languages that are able to be upgraded can be found under ACP -> Appearance -> Languages -> Upgradeable languages. When you are ready to upgrade, choose “Upgrade” next to the language. The list of upgradeable languages is only shown when an update has been found.

To access the Install and Upgrade log, navigate to ACP -> Logs -> Miscellaneous -> Install & Upgrade log. Here you can view the actions taken and filter by various criteria.

Administrator Permission The “Manage [TH] Install & Upgrade profiles” administrator permission can be set.

If you are hosting your own software to provide add-ons, styles or languages for XenForo, you may hook into Install & Upgrade by providing your own Install & Upgrade handler. You may push it to our GitHub repository and we’ll bundle it up with the next release, or you can release it as a separate add-on that hooks into Install & Upgrade. You can find a number of interfaces in `ThemeHouse/InstallAndUpgrade/InstallAndUpgrade/Interfaces`. You may implement any of them as you need. Common implementations and tools can be found in `ThemeHouse/InstallAndUpgrade/InstallAndUpgrade/Traits`. Install & Upgrade detects available handlers via the `th_installupgrade_handler` content type.