Andreas/evennia
1
0
Fork 0
mirror of https://github.com/evennia/evennia.git synced 2026-03-22 15:56:30 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Updated README per comments

Browse source
This commit is contained in:
Wendy Wang 2025-01-20 17:06:49 +01:00
parent 47442beaf7
commit b995e0340f
1 changed files with 21 additions and 6 deletions
Download patch file Download diff file Expand all files Collapse all files

27
evennia/contrib/utils/database_backup/README.md
View file

@ -10,7 +10,7 @@ Currently, the sqlite3 (the evennia default) and postgresql databases are suppor
## Installation
This utility adds the `backup` command. Import the module into your commands and add it to your command set to make it available.
This utility adds the `backup` command. The `backup` command can be used to set up a scheduled backup script, or trigger the script to run immediately. The backup script makes a backup of your game world. Import the module into your commands and add it to your command set to make it available.
In `mygame/commands/default_cmdsets.py`:
@ -28,6 +28,21 @@ class CharacterCmdset(default_cmds.Character_CmdSet):
Then `reload` to make the `backup` command available.
If you prefer to run the script without the `backup` command, you can manage it as a global script in your settings:
```python
# in mygame/server/conf/settings.py
GLOBAL_SCRIPTS = {
"backupscript": {
"typeclass": "evennia.contrib.utils.database_backup.DatabaseBackupScript",
"repeats": -1,
"interval": 86400,
"desc": "Database backup script"
},
}
```
## Permissions
By default, the backup command is only available to those with Developer permissions and higher. You can change this by overriding the command and setting its locks from "cmd:pperm(Developer)" to the lock of your choice.
@ -43,16 +58,16 @@ Remember to `evennia stop` before restoring your db.
### Restoring sqlite3 (.db3)
* Copy the database backup you want to restore from back into the `server/` directory
* Rename the database backup to `evennia.db3` if you have not modified `settings.DATABASES`, otherwise whatever name is in your `settings.DATABASES` dictionary.
* By default (unless you changed the name of the file in `settings DATABASES`), the game data is expected to be located in the sqlite3 file `mygame/server/evennia.db3`. Copy your backup file over this file to recover your backup.
### Restoring postgres (.sql)
* Prepare the following variables
```
export DB_USER=db_user from your settings.DATABASES
export DB_NAME=db_name from your settings.DATABASES
export BACKUP_FILE=the path to the backup file you are restoring from
export PGPASSWORD=your db password
export DB_USER=db_user # db_user from your settings.DATABASES
export DB_NAME=db_name # db_name from your settings.DATABASES
export BACKUP_FILE=backup_file_path # the path to the backup file you are restoring from
export PGPASSWORD=db_password # the password to your db
If you prefer not to export your password to an env variable, you can enter it when prompted instead.
```