Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/j-isreal/bash-odoo-backup

BASH script to backup the Odoo database and files
https://github.com/j-isreal/bash-odoo-backup

Last synced: about 1 month ago
JSON representation

BASH script to backup the Odoo database and files

Host: GitHub
URL: https://github.com/j-isreal/bash-odoo-backup
Owner: j-isreal
License: apache-2.0
Created: 2024-09-10T07:40:13.000Z (5 months ago)
Default Branch: main
Last Pushed: 2024-09-13T00:28:52.000Z (4 months ago)
Last Synced: 2024-11-06T09:14:29.029Z (3 months ago)
Language: Shell
Size: 26.4 KB
Stars: 0
Watchers: 1
Forks: 0
Open Issues: 0
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# bash-odoo-backup
BASH script to backup the Odoo database and filestore locally **and** to s3 cloud storage

**More Info on Odoo**

Odoo is an awesome ERP / Accounting / CRM platform!

I use the community edition (open-source, self-hosted) nightly version (17.0) from their community nightly build on an Ubuntu server with Postgresql 16 and Nginx.

- For more info on Odoo: https://www.odoo.com/page/download

- For more info on how to setup and install Odoo: [visit my website](https://www.jinet.us/dev/dev-projects/setting-up-odoo-17-ubuntu/)

**REQUIRES:** curl - _install on Ubuntu with:_ ```apt-get install curl```

## 1. Setup s3cmd and cloud storage space
**FIRST**, either comment out the ```s3cmd``` lines, or setup s3cmd.

s3cmd is available from the linux repositories. You can use any AWS (Amazon)-compatible cloud storage service.

I prefer DigitalOcean Spaces - it's only $5.00 a month for 250GB of storage.

Here's a $250 credit with them:

[![DigitalOcean Referral Badge](https://web-platforms.sfo2.cdn.digitaloceanspaces.com/WWW/Badge%201.svg)](https://www.digitalocean.com/?refcode=7774aa9a2bfa&utm_campaign=Referral_Invite&utm_medium=Referral_Program&utm_source=badge)

### 1a. Ensure your s3cfg is configured and you can access the cloud storage
The ```s3cmd --configure``` command will setup s3cmd for you, and verify it's working.

- You will need your API key and secret to configure s3cmd.

- Visit [DigitalOcean](https://docs.digitalocean.com/products/spaces/reference/s3cmd/) for complete instructions.

Use the following to setup s3cmd:
```
s3cmd --configure
```

See following links for details:
- DO Spaces: https://docs.digitalocean.com/products/spaces/
- DO Spaces using s3cmd: https://docs.digitalocean.com/products/spaces/reference/s3cmd-usage/
- s3cmd usage: https://s3tools.org/usage

## 2. Update script with variables
Update the script variables at the top of the ```odoo-backup.sh``` script with your Odoo Master Admin password and Database name, backup folder path, and S3 bucket name:
```
BACKUP_DIR=/backup
ODOO_DATABASE=ENTER-DB-NAME
ADMIN_PASSWORD=EnTerAdminPwd
S3BUCKET_NAME=bucketname
```

## 3. Make executable, set cron for automated backup
Make the file executable with:
```
chmod +x backup-odoo.sh
```

Then you can run the script with:
```
./backup-odoo.sh
```

For automated backups, set your root cron as such:
```
crontab -e
# For more information see the manual pages of crontab(5) and cron(8)
#
# m h dom mon dow command
30 1 * * * sh /root/backup-odoo.sh
```

Be sure to prepend the script with ```sh ``` as shown above or the script won't work in cron.