Home:FERP: Difference between revisions

From Esoul Wiki
Jump to navigation Jump to search
 
(18 intermediate revisions by the same user not shown)
Line 3: Line 3:
=== Install ===
=== Install ===


=== Update ===
=== Update & Roll-Back ===


Please follow the following instruction to update .
To update from an old version to a newer version, you need to
1. Backup the database.
# Backup the system.
2. Stop the web server so that no transition.
# Stop the web server.
2. Update the packages.json npm.
# Install the new packages.json.
3. FERP provides {{code|inline=y|lang=css|font-family: 'Times New Roman', serif;}}
# Run '''npm run ferp-update''' and follow the instruction. If you're running a very old version, maybe you can't update to the newest version directly. You have to update to a certain version at first.
5. Start the web server again.
# Start the web server.


It's notable that if your current version is too old, maybe you're not allowed to update to the newest version directly.  may have to update to a certain version at first


=== Backup & Restore ===
FERP doesn't support roll-back. You may and should backup your system at first if you want to update to a newer version. In this way, you can restore to the old version if there's any issue. However, you can't roll-back to an old version with the new data.
 
=== Backup, Restore & Move ===


FERP use a central database to store everything. You can use different tools to backup and restore the database.
FERP use a central database to store everything. You can use different tools to backup and restore the database.
Line 20: Line 21:
Depending on your requirements, maybe you also want to backup the global configuration file '''config.json'''.
Depending on your requirements, maybe you also want to backup the global configuration file '''config.json'''.


Backup / Restore is a safe way to move a system from one to server to another server if and only if:
Backup / Restore is a safe way to move a system from one server to another server if and only if the both server are:
- The both
# running exact the same FERP version (including all plugins).
# running exact the same database version.
# reachable under the same URL (domain name).
 
You may have to shutdown the old server before restoring to the new server. You can follow this [[FERP: Change Domain | instruction]] to change domain before or after the movement.


'''WARNING''':
'''WARNING''':
* Both the database and the configuration file contain sensitive data. Never store or transmit them in an insecure way.
# Both the database and the configuration file contain sensitive data. Never store or transmit them in an insecure way.
* Always verify the source of the data before restoring the system.
# Always verify the source of the data before restoring the system.


=== Cleanup ===
=== Cleanup ===

Latest revision as of 16:15, 11 June 2025

IM (Install & Maintain)

Install

Update & Roll-Back

To update from an old version to a newer version, you need to

  1. Backup the system.
  2. Stop the web server.
  3. Install the new packages.json.
  4. Run npm run ferp-update and follow the instruction. If you're running a very old version, maybe you can't update to the newest version directly. You have to update to a certain version at first.
  5. Start the web server.


FERP doesn't support roll-back. You may and should backup your system at first if you want to update to a newer version. In this way, you can restore to the old version if there's any issue. However, you can't roll-back to an old version with the new data.

Backup, Restore & Move

FERP use a central database to store everything. You can use different tools to backup and restore the database.

Depending on your requirements, maybe you also want to backup the global configuration file config.json.

Backup / Restore is a safe way to move a system from one server to another server if and only if the both server are:

  1. running exact the same FERP version (including all plugins).
  2. running exact the same database version.
  3. reachable under the same URL (domain name).

You may have to shutdown the old server before restoring to the new server. You can follow this instruction to change domain before or after the movement.

WARNING:

  1. Both the database and the configuration file contain sensitive data. Never store or transmit them in an insecure way.
  2. Always verify the source of the data before restoring the system.

Cleanup