-
Notifications
You must be signed in to change notification settings - Fork 219
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[Issue #358] Fix: README and documentation for version 1.14
Changes include updating the current README file to reflect the update from version 1.12 to version 1.14 of koalixcrm. A new detailed update guide has been added to the documentation, providing users with specific instructions for this version update, along with advice for backup and installation of Docker to support the new version.
- Loading branch information
Showing
2 changed files
with
58 additions
and
2 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1 +1,57 @@ | ||
# koalixcrm Update from V1.12 to V1.14 | ||
|
||
<b>Important:</b> This guide is specifically tailored to guide you through the update process from version V1.12 to V1.14. | ||
Other version migrations may not work with this guidance or may behave differently. | ||
|
||
## Support | ||
|
||
Just like the installation, a certain expertise in server administration is needed to update koalixcrm. | ||
For questions or support, please refer to our website http://www.koalix.com, where you can find more information about our services. | ||
|
||
## Limitations | ||
|
||
This update functionality is written exclusively for the transition from V1.12 to V1.14. It has not been tested | ||
for other version migrations, and the functionality is not guaranteed for such cases. Make sure you're updating from | ||
a properly tagged version (V1.12) to another tagged version (V1.14), and refrain from using the master branch for this process. | ||
|
||
<b>Warning: The update from V1.12 to V1.14 might result in changes to your system. It's always recommended to backup | ||
your data before proceeding.</b> | ||
|
||
## Before you update | ||
|
||
It's strongly recommended that you backup both your koalixcrm project folder and your database before proceeding with | ||
the update, because the process might introduce changes that would be irreversible otherwise. | ||
|
||
# Update process | ||
|
||
## Backup database and KoalixCRM | ||
|
||
Backup your current database Backup your existing koalixcrm project folder | ||
|
||
## Install Docker | ||
|
||
In version V1.14, we are transitioning to Docker for smoother operation. Therefore, Docker must be installed before the | ||
update. You can follow the Docker official documentation for the installation guide. | ||
|
||
## Setup the new container | ||
|
||
Once Docker is installed, go to https://github.com/KoalixSwitzerland/koalixcrm-prod-container and clone the repository. | ||
|
||
## Edit Docker-compose file | ||
|
||
Navigate into the cloned repository and open the docker-compose file. Update the settings according to your system. | ||
|
||
## Restore your files and database from your backup | ||
|
||
After setting up the new container and configuring the Docker-compose file, it's time to restore your files and the | ||
database from your backups you made earlier. | ||
|
||
## Run the container | ||
|
||
Now run the following command in your terminal: | ||
|
||
'''docker-compose up''' | ||
|
||
With this, your koalixcrm application should now be updated from V1.12 to V1.14 and running in the new Docker container. | ||
|
||
Enjoy using KoalixCRM! |