From 007c7d212c6b853170780b92a1191b696e2afd1b Mon Sep 17 00:00:00 2001 From: Sebastian Serth Date: Tue, 24 Aug 2021 15:54:33 +0200 Subject: [PATCH] Add draft for backup strategy --- docs/backup.md | 12 ++++++++++++ 1 file changed, 12 insertions(+) create mode 100644 docs/backup.md diff --git a/docs/backup.md b/docs/backup.md new file mode 100644 index 00000000..80d4fa5a --- /dev/null +++ b/docs/backup.md @@ -0,0 +1,12 @@ +# Backups + +CodeOcean persists most data in the PostgreSQL database including submissions and the respective user files. Only binary files that cannot be serialized are stored in the `public/uploads` folder in dedicated sub-folders with the ID as folder name. Necessary files are temporarily extracted to the container's file system during execution but don't need to backed up separately. + +## Summary + +In order to back up CodeOcean, you should consider these locations: + +- `config/*.yml` and `config/*.yml.erb` +- The values of [environment variables](environment_variables.md) set for the web server +- PostgreSQL database as specified in `config/database.yml` +- `public/uploads` and all sub-folders