diff --git a/auto_database_backup/static/description/index.html b/auto_database_backup/static/description/index.html index 5a6ae246b..791350257 100644 --- a/auto_database_backup/static/description/index.html +++ b/auto_database_backup/static/description/index.html @@ -1,1786 +1,1713 @@ +
- This Module Helps To Generate Automated Backup Of Databases.
-- Generate automatic backup of databases and store to local, - google drive, dropbox, nextcloud, amazon S3, onedrive or - remote server, Odoo17 -
-+ This Module Helps To Generate Automated Backup Of Databases.
++ Generate automatic backup of databases and store to local, + google drive, dropbox, nextcloud, amazon S3, onedrive or + remote server, Odoo17 +
+- Generate Database Backups on regular - intervals.
++ Generate Database Backups on regular + intervals.
+- Automatically remove old backups that consumes - storage space.
++ Automatically remove old backups that consumes + storage space.
+- Notify user on success and failure of backup - generation. -
++ Notify user on success and failure of backup + generation. +
+- Store to Remote Servers, Nextcloud, Amazon S3, - Google Drive, Dropbox, Onedrive.
++ Store to Remote Servers, Nextcloud, Amazon S3, + Google Drive, Dropbox, Onedrive.
++ Automatic Database Backup.
+- Automatic Database Backup.
-pip install dropbox
- pip install dropbox
+ pip install pyncclient
- pip install pyncclient
+ pip install
+
+
+ This module uses an external python dependency
+ 'nextcloud-api-wrapper'. Before
+ installing the module install the python
+ package
+ first. The required python package can be installed using the
+ following command,
+
+ pip install
nextcloud-api-wrapper
-
+
pip install boto3
- pip install boto3
+ pip install paramiko
+ pip install paramiko
- Automatic Database Backup.
-- Go to Setting --> Technical --> Backup Configuration - to configure backups.
-- Enter the Database Name and Master - Password. Specify Backup Destination. - Enter the backup directory path, if - directory does not exist new - directory will be created. -
-- Select Backup Destination as SFTP, enter - credentials. - "TEST CONNECTION" button to check whether - the connection is - successful.
-- Select Backup - Destination - as FTP, enter credentials. - "TEST CONNECTION" button to check whether - the connection is - successful.
-+ Automatic Database Backup.
++ Go to Setting --> Technical --> Backup Configuration + to configure backups.
+- You'll need to create a - new - Google API project and enabling the Google - Drive API, Go to the - Google API Console - and log into your - account. - While creating the project, for the - Redirect URI restrictions, - copy your Odoo database URI followed by - /google_drive/authentication. Example:
-- ENABLE API AND SERVICES -
-- ENALBE GOOGLE DRIVE API -
-- Create Credentials, - Follow - the steps, select Website application for - the Application - Type. -
-- Under the Authorized - JavaScript Origins section, click + Add URI - and type your - company's Odoo URL address. - Under the Authorized redirect URIs section, - click + Add URI and - type your company's Odoo URL address - followed - by /google_drive/authentication. - After all the steps are completed, A Client - ID and Client secret will - be given, copy the credentials -
-- Go to the "OAuth consent screen", then Test - users and click on 'ADD USERS' then add the - user. -
-- Configure Backup, Copy - Client ID and Client Secret from Google - Drive API Credentials - page into their respective fields.
-- Setup Token, it will - be - redirected to an authorization page.
-- Grant Access
-- Reset the token if - required by clicking on the "Reset - Token"
-+ Enter the Database Name and Master + Password. Specify Backup Destination. + Enter the backup directory path, if + directory does not exist new + directory will be created. +
+- To get the app key and secret key go to the - App - Console. - Create a new app -
-+ Select Backup Destination as SFTP, enter + credentials. + "TEST CONNECTION" button to check whether + the connection is + successful.
+- Once you created the App , you can get the App - key and App Secret as seen in the screenshot. -
-- Choose your app's permission - (files.content.write and files.content.read - permissions required).then click on Submit -
-- Choose Dropbox as that of the backup - destination. Enter the app secret and key and - dropbox Folder. -
-- Click on the Setup Token -
-- Get the Authorization - Code - and click confirm. -
-+ Select Backup + Destination + as FTP, enter credentials. + "TEST CONNECTION" button to check whether + the connection is + successful.
+- Reset the refresh token - if - required by clicking on the "Reset - Token" -
-+ You'll need to create a + new + Google API project and enabling the Google + Drive API, Go to the + Google API Console + and log into your + account. + While creating the project, for the + Redirect URI restrictions, + copy your Odoo database URI followed by + /google_drive/authentication. Example: +
++ ENABLE API AND SERVICES +
++ ENALBE GOOGLE DRIVE API +
++ Create Credentials, + Follow + the steps, select Website application for + the Application + Type. +
++ Under the Authorized + JavaScript Origins section, click + Add URI + and type your + company's Odoo URL address. + Under the Authorized redirect URIs section, + click + Add URI and + type your company's Odoo URL address + followed + by /google_drive/authentication. + After all the steps are completed, A Client + ID and Client secret will + be given, copy the credentials +
++ Go to the "OAuth consent screen", then Test + users and click on 'ADD USERS' then add the + user. +
++ Configure Backup, Copy + Client ID and Client Secret from Google + Drive API Credentials + page into their respective fields.
++ Setup Token, it will + be + redirected to an authorization page.
++ Grant Access
++ Reset the token if + required by clicking on the "Reset + Token"
++ To get the app key and secret key go to the + App + Console. + Create a new app +
+- Select Backup - Destination - as OneDrive. Enter the App key and App - secret. - you'll need to register a new app in the Microsoft - Azure - portal. - While registering the app for the Redirect - URI restrictions, - copy your Odoo database URI followed by - /onedrive/authentication. Example: -
-- Copy the Client ID -
-- Generate Client Secret. -
-- Get OneDrive folder ID, - where need to store the backup files. -
-- Configure the Backup. -
-- Setup Token, it will be - redirected to an authorization page. -
-- Grant Access -
-- Reset the token if - required by clicking on the "Reset Token" -
-+ Once you created the App , you can get the App + key and App Secret as seen in the screenshot. +
++ Choose your app's permission + (files.content.write and files.content.read + permissions required).then click on Submit +
++ Choose Dropbox as that of the backup + destination. Enter the app secret and key and + dropbox Folder. +
++ Click on the Setup Token +
++ Get the Authorization + Code + and click confirm. +
++ Reset the refresh token + if + required by clicking on the "Reset + Token" +
+- To Create an account in Nextcloud go to - https://nextcloud.com/sign-up/, Enter Your - Email Address and - Sign up . -
-- You will be redirected to the page as shown - in the screenshot, - and it will ask you enter your email and - password for the - Nextcloud. -
-- To get the Domain of the Nextcloud.Go to - Settings in the - Nextcloud and Click on Mobile & desktop. - You will see server - address Copy link and paste it in your - Domain Name. -
-- Select the backup destination as Nextcloud. - Enter the Domain - Name, UserName, Password and Folder Name - where you want to store - your backup on the NextCloud server. Check - the Connect button - to check if the connection is successful. -
-- Every day, a Scheduled Action will take - place to store a backup - on the Nextcloud Server. The backup will be - stored as the folder - name provided in the Folder ID field in - Odoo. -
-+ Select Backup + Destination + as OneDrive. Enter the App key and App + secret. + you'll need to register a new app in the Microsoft + Azure + portal. + While registering the app for the Redirect + URI restrictions, + copy your Odoo database URI followed by + /onedrive/authentication. Example: +
+- To Create an account in Amazon S3 go to - https://portal.aws.amazon.com/billing/signup#/start/email, - Enter - Your Email Address and Sign up . -
-- After you created the account.You need to - get the Access Key and - Secret Key,To get these go the account - Security credentails and - go the Access Keys and create new access - keys from there you - will get Access Key and Secret Key. -
-- Next You need to create a Bucket Folder in - the Amazon S3.To do - that Go the Services in the top right and - go to Storage and S3 - as shown in the Screen shot. -
-- To create Bucket folder,Click on the Create - bucket Button. -
-- On Creating a Bucket Folder,Check the rules - for naming the - Bucket folder,and Select the region as - well.After that click on - the create Bucket Button in the bottom of - the page. -
-- You will see the Bucket Folder as shown in - the screenshot. -
-- Select Backup Destination as Amazon S3. - Enter the Amazon S3 - Access Key,Amazon S3 Secret Key,Bucket - Name->Bucket folder you - have created in the Amazon S3 and the File - Name->The Folder You - want to store your backup in Amazon S3 - Bucket Folder.Test - connection button to check whether the - connection is - successful. -
-+ Copy the Client ID +
++ Generate Client Secret. +
++ Get OneDrive folder ID, + where need to store the backup files. +
++ Configure the Backup. +
++ Setup Token, it will be + redirected to an authorization page. +
++ Grant Access +
++ Reset the token if + required by clicking on the "Reset Token" +
+- Every day, a Scheduled Action will take - place to store a backup - on the Amazon S3 Server. The backup will be - stored as the folder - name provided in the File Name field in - Odoo. -
-+ To Create an account in Nextcloud go to + https://nextcloud.com/sign-up/, Enter Your + Email Address and + Sign up . +
++ You will be redirected to the page as shown + in the screenshot, + and it will ask you enter your email and + password for the + Nextcloud. +
++ To get the Domain of the Nextcloud.Go to + Settings in the + Nextcloud and Click on Mobile & desktop. + You will see server + address Copy link and paste it in your + Domain Name. +
++ Select the backup destination as Nextcloud. + Enter the Domain + Name, UserName, Password and Folder Name + where you want to store + your backup on the NextCloud server. Check + the Connect button + to check if the connection is successful. +
++ Every day, a Scheduled Action will take + place to store a backup + on the Nextcloud Server. The backup will be + stored as the folder + name provided in the Folder ID field in + Odoo. +
+- Enable auto remove - option, - specify number of days to remove - backups.
-+ To Create an account in Amazon S3 go to + https://portal.aws.amazon.com/billing/signup#/start/email, + Enter + Your Email Address and Sign up . +
++ After you created the account.You need to + get the Access Key and + Secret Key,To get these go the account + Security credentails and + go the Access Keys and create new access + keys from there you + will get Access Key and Secret Key. +
++ Next You need to create a Bucket Folder in + the Amazon S3.To do + that Go the Services in the top right and + go to Storage and S3 + as shown in the Screen shot. +
++ To create Bucket folder,Click on the Create + bucket Button. +
++ On Creating a Bucket Folder,Check the rules + for naming the + Bucket folder,and Select the region as + well.After that click on + the create Bucket Button in the bottom of + the page. +
++ You will see the Bucket Folder as shown in + the screenshot. +
++ Select Backup Destination as Amazon S3. + Enter the Amazon S3 + Access Key,Amazon S3 Secret Key,Bucket + Name->Bucket folder you + have created in the Amazon S3 and the File + Name->The Folder You + want to store your backup in Amazon S3 + Bucket Folder.Test + connection button to check whether the + connection is + successful. +
++ Every day, a Scheduled Action will take + place to store a backup + on the Amazon S3 Server. The backup will be + stored as the folder + name provided in the File Name field in + Odoo. +
+- Enable notify user - option, - and select a user to notify. An email - notification will be sent - to the selected user on - backup successful and failure. -
-+ Enable auto remove + option, + specify number of days to remove + backups.
++ Enable notify user + option, + and select a user to notify. An email + notification will be sent + to the selected user on + backup successful and failure. +
+- Enable the 'Automatic - database Backup' scheduled action, and set - up the execution - interval. - Based on the scheduled action setup, - backups will be generated - on regular intervals. -
-+ Enable the 'Automatic + database Backup' scheduled action, and set + up the execution + interval. + Based on the scheduled action setup, + backups will be generated + on regular intervals. +
+- Comprehensive Features of AUTOMATIC DATABASE - BACKUP
-+ Comprehensive Features of AUTOMATIC DATABASE + BACKUP
+- Current Stock Report for all Products in each - Warehouse.
-- After each backup attempt, you will - receive a notification indicating - whether it was successful or if it - encountered a failure. -
++ Current Stock Report for all Products in each + Warehouse.
++ After each backup attempt, you will + receive a notification indicating + whether it was successful or if it + encountered a failure. +
+- On the Backup Configuration, we have - the option to select a backup format - whether zip or dump. Choosing zip - will provide filestore while dump - will not. -
+ + ++ On the Backup Configuration, we have + the option to select a backup format + whether zip or dump. Choosing zip + will provide filestore while dump + will not. +
+- Enable auto-remove option from - backup configuration to - automatically delete old backups. -
+ + ++ Enable auto-remove option from + backup configuration to + automatically delete old backups. +
+- Certainly! You can back up directly - to your local system by selecting - the destination as local storage and - specifying the desired path for the - backup. -
+ + ++ Certainly! You can back up directly + to your local system by selecting + the destination as local storage and + specifying the desired path for the + backup. +
+Version 17.0.2 I Updated + on : 31st November 2023 +
+Updated the database name check function + which got access denied when + list_db=False.
+Version 17.0.1 I Released + on : 6th October 2023 +
+Initial commit for + auto_database_backup
+Version 17.0.2 I Updated on : 31st November 2023 -
-Updated the database name check function - which got access denied when - list_db=False.
-Version 17.0.1 I Released on : 6th October 2023 -
-Initial commit for - auto_database_backup
Explore our related modules
-