Skip to content

Commit

Permalink
📖 upd docs based on dev and seo feedbacks'
Browse files Browse the repository at this point in the history
  • Loading branch information
ruzilia committed Jun 30, 2019
1 parent 89cc726 commit 28ba34a
Show file tree
Hide file tree
Showing 28 changed files with 151 additions and 137 deletions.
2 changes: 1 addition & 1 deletion odoo_backup_sh/__manifest__.py
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
"summary": """Remote Backup Service""",
"category": "Backup",
# "live_test_url": "",
"images": [],
"images": ['images/odoo_backup_sh.jpg'],
"version": "12.0.1.0.0",

"author": "IT-Projects LLC, Stanislav Krotov",
Expand Down
46 changes: 20 additions & 26 deletions odoo_backup_sh/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -62,33 +62,27 @@ Each database specified in these settings will be presented in the dashboard.
Usage
=====

* Login into your `Odoo account <https://www.odoo.com/web/login>`__
* Click on ``Create Database`` button
* In the open Pop-up window enter *Master Password*, fill required information such as Phone number, Language, Country, Password
* Provide the name for Database
* Click on ``Continue`` button

RESULT: Backup is created.
*The manual database creation may take some time before being ready*.

* Login into your `Odoo account <https://www.odoo.com/web/login>`__
Backups:

* Open the menu ``[[ Backups ]] >> Dashboard``
* After redireсtion please login into your `Odoo account <https://www.odoo.com/web/login>`__
* Set up a new configuration [[ Backups ]] >> Dashboard >> Add Database
* Choose the Database in the database field
* Encrypt your backup if you need, but do not forget the password
* Enter *Interval Number*, *Interval Unit*, *New execution Date*
* Select/unselect *"Active"* checkbox
* Click on ``Save`` button
* Go to ``[[ Backups ]] >> Dashboard``
* Click on ``New Backup`` in the appeared configuration

Restore:

* Please proceed to the Database Manager: ``/web/database/manager``
* Click on ``Restore via Odoo-backup.sh`` button
* Choose the backup that you want to restore
* In the open Pop-up window enter *Master Password*, fill the *Database Name*
* Click on `Restore` button

RESULT: Backup is restored without any additional manipulations such as *downloading-uploading* process.
*The database restore may take some time before being ready*.

* Login into your `Odoo account <https://www.odoo.com/web/login>`__
* Click on ``Restore`` button
* Upload file that you want to restore
* Think up the Database Name
* In order to avoid conflicts between databases, choose the option if this database was moved or copied.
* In the open Pop-up window enter *Master Password*, fill the *Database Name*
* Click on `Continue` button

* In the open Pop-up window enter Master Password, fill the Database Name*
* In order to avoid conflicts between databases choose if this database was moved or copied*
* Click on ``Continue`` button

RESULT: Backup is restored.
RESULT: Backup is restored in one click without any additional manipulations such as "downloading-uploading process".
*The database restore may take some time before being ready*.

Binary file added odoo_backup_sh/images/odoo_backup_sh.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed odoo_backup_sh/static/description/create.png
Binary file not shown.
Binary file added odoo_backup_sh/static/description/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed odoo_backup_sh/static/description/delete.png
Binary file not shown.
Binary file removed odoo_backup_sh/static/description/duplicate.png
Binary file not shown.
142 changes: 57 additions & 85 deletions odoo_backup_sh/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan">Odoo Backups </h2>
<h3 class="oe_slogan"> Create, save, duplicate, delete, restore backups</h3>
<h3 class="oe_slogan"> Restore backups in one click</h3>
</div>
</div>
</section>
Expand All @@ -11,8 +11,11 @@ <h3 class="oe_slogan"> Create, save, duplicate, delete, restore backups</h3>
<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
Main feature: no need to download and upload a database archive via a browser.
Also you can encrypting backup archives.
<ul>
<li> This module provides an additional option for simplifying the process of managing backups with the <i>Restore a backup via Odoo-backup.sh</i> button.</li>
<li> Main feature: no need to download and upload a database archive via a browser.</li>
<li> Also you can encrypting backup archives.</li>
</ul>
</p>
</div>
</div>
Expand All @@ -23,121 +26,90 @@ <h3 class="oe_slogan"> Create, save, duplicate, delete, restore backups</h3>
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h3 class="oe_slogan">How it works</h3>
<h2 class="oe_slogan">Backups </h2>
<p class="oe_mt32">
Go to <b>Backup Dashboard</b> and press <i>Add</i> button
Open the menu <b>[[ Backups ]] >> Dashboard</b>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="add_button.png"/>
<img src="dashboard.png"/>
</div>
<p class="oe_mt32">
Login into your <a href="https://www.dropbox.com/developers/apps"> Odoo account </a> and start your backup process
After redirection please login into your <a href="https://www.dropbox.com/developers/apps"> Odoo account </a>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="odoo.png"/>
</div>
</div>
</div>
</section>

<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
This service provides a wide range of options for managing backups
Set up a new configuration <b>[[ Backups ]] >> Dashboard >> Add Database</b>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="add_button.png"/>
</div>
<p class="oe_mt32">
<ul>
<li>Save a backup </li>
<li>Duplicate a backup</li>
<li>Delete a backup</li>
<li>Create a backup</li>
<li>Restore a backup</li>
<li>Restore a backup via Odoo-backup.sh module</li>
<li> Choose the Database in the database field</li>
<li> Encrypt your backup if you need, but do not forget the password</li>
<li> Enter <i>Interval Number, Interval Unit, New execution Date</i></li>
<li> Select/unselect <i>"Active"</i> checkbox </li>
<li> Click on <b>Save</b> button </li>
<li> Go to <b>[[ Backups ]] >> Dashboard</b> </li>
<li> Click on <b>New Backup</b> in the appeared configuration </li>
</ul>
</p>
</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
Save a backup by choosing format you need to and confirm the action with a Master password</i>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="save.png"/>
<img src="configuration.png"/>
</div>
</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
Duplicate a backup by setting up a new name and confirm the action with a Master password</i>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="duplicate.png"/>
<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
You can see details of your backups in the <i>Table format</i>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="odoosh_details_table.png"/>
</div>
</div>
</div>
</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
Delete a backup by confirming the action with a Master password</i>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="delete.png"/>
<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
You can see a <i>Visual representation</i> of your backups</i>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="odoosh_dashboard.png"/>
</div>
</div>
</div>
</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<h2 class="oe_slogan">Restore </h2>
<p class="oe_mt32">
Create a backup by filling special forms and confirm the action with a Master password</i>
</p>
<ul>
<li> Please proceed to the Database Manager: <b>/web/database/manager </b> </li>
<li> Click on <b>Restore via Odoo-backup.sh</b> button </li>
<div class="oe_demo oe_picture oe_screenshot">
<img src="create.png"/>
<img src="odoo.png"/>
</div>
</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
<p class="oe_mt32">
Restore a backup by choosing an archive and confirm the action with a Master password</i>
</p>
<li> Choose the backup that you want to restore</li>
<div class="oe_demo oe_picture oe_screenshot">
<img src="restore.png"/>
<img src="restoresh.png"/>
</div>
</div>
</div>
</section>

<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
</ul>
</p>
<p class="oe_mt32">
Restore backups via Odoo-backup.sh module just pressing appropriate buttons from the right side</i>
<ul>
<li> In the open Pop-up window enter <i>Master Password</i>, fill the <i>Database Name</i> </li>
<li> In order to avoid conflicts between databases choose if this database <i>was moved</i> or <i>copied</i> </li>
<li> Click on <b>Continue</b> button</li>
</ul>
</p>
<div class="oe_demo oe_picture oe_screenshot">
<img src="restoresh.png"/>
<img src="popup.png"/>
</div>
Backup is restored in one click without any additional manipulations such as <i>downloading-uploading</i> process.
</div>
</div>
</section>



<section class="oe_container">
<div class="oe_row oe_spaced">
<div class="oe_span8">
Expand Down
Binary file modified odoo_backup_sh/static/description/odoo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added odoo_backup_sh/static/description/popup.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed odoo_backup_sh/static/description/restore.png
Binary file not shown.
Binary file removed odoo_backup_sh/static/description/save.png
Binary file not shown.
22 changes: 16 additions & 6 deletions odoo_backup_sh_dropbox/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -51,10 +51,20 @@ Config Settings
Usage
=====

* Open the menu ``[[ Backups ]] >> Dashboard``
* Proceed with ``[[ Backups ]] >> Backups`` where Dropbox databases are presented
* Go to ``[[Backup]] >> Configuration >> Schedules and Rotations``
* See ``[[Backup]] >> Notifications`` if new one is displayed
* Open the menu ``[[ Backups ]] >> Settings``
* Choose the Dropbox and click on ``Save`` button
* Enter *Dropbox Access Token*
* Enter *Dropbox Folder Path*
* Click on ``Save`` button
* Set up a new configuration [[ Backups ]] >> Dashboard >> Add Database
* Choose the Database in the database field
* Define the Storage service
* Encrypt your backup if you need, but do not forget the password
* Enter *Interval Number*, *Interval Unit*, *New execution Date*
* Select/unselect *"Active" checkbox*
* Click on ``Save`` and come back to set up the feature
* Go to ``[[ Backups ]] >> Dashboard``
* Click on ``New Backup`` in the appeared configuration

RESULT: You can see the main Graph with the general statistics of all your backups are stored on a remote server. After this window a special form for managing and controlling backups of your databases specially *for Dropbox* is located.
In addition to auto backup, you can make new backups manually at any time. Backups *taken by hand* are not involved in auto rotation conditions.
RESULT: Backup is stored in the Dropbox cloud.
*Note: Restore without additional downloading is available only for* `Odoo backup service <https://apps.odoo.com/apps/modules/12.0/odoo_backup_sh/>`__
Binary file removed odoo_backup_sh_dropbox/images/backup_dropbox.jpg
Binary file not shown.
Binary file modified odoo_backup_sh_dropbox/static/description/backup_config.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified odoo_backup_sh_dropbox/static/description/backups_table.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified odoo_backup_sh_dropbox/static/description/dashboard.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
23 changes: 19 additions & 4 deletions odoo_backup_sh_dropbox/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -82,10 +82,25 @@ <h3 class="oe_slogan">How it works</h3>
<div class="oe_span12">
<p class="oe_mt32">
<ul>
<li>Define the <i>Name</i> </li>
<li>Create the <i>Password</i> if you want to encrypt the Backup</li>
<li>Schedule Auto Backups</li>
<li>Set up how many backups to preserve for certain time frames</li>
<li>Open the menu <b>[[ Backups ]] >> Settings</b></li>
<li>Choose the Dropbox and click on ``Save`` button</li>
<li>Enter <i>Dropbox Access Token</i></li>
<li>Enter <i>Dropbox Folder Path</i></li>
<li>Click on ``Save`` and come back to set up the feature</li>
</ul>
<div class="oe_demo oe_picture oe_screenshot">
<img src="dropbox_config.png"/>
</div>
<ul>
<li>Set up a new configuration <b>[[ Backups ]] >> Dashboard >> Add Database</b></li>
<li>Choose the Database in the database field</li>
<li>Define the Storage service</li>
<li>Encrypt your backup if you need, but do not forget the password</li>
<li>Enter <i>Interval Number</i>, <i>Interval Unit</i>, <i>New execution Date</i></li>
<li>Select/unselect <i>"Active" checkbox</i></li>
<li>Click on ``Save``</li>
<li>Go to ``[[ Backups ]] >> Dashboard``</li>
<li>Click on ``New Backup`` in the appeared configuration</li>
</ul>
</p>
<div class="oe_demo oe_picture oe_screenshot">
Expand Down
28 changes: 17 additions & 11 deletions odoo_backup_sh_google_disk/doc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,14 +69,20 @@ Server Deployment
Usage
=====

* Open the menu ``[[ Backups ]] >> Dashboard``
* Proceed with ``[[ Backups ]] >> Backups`` where Google drive databases are presented
* ``[[ Backups ]] >> Backups``
* Go to ``[[Backup]] >> Configuration >> Schedules and Rotations``
* See ``[[Backup]] >> Notifications`` if new one is displayed


RESULT: You can see the main Graph with the general statistics of all your backups are stored on a remote server. After this window a special form for managing and controlling backups of your databases specially *for Google drive* is located.
In addition to auto backup, you can make new backups manually at any time. Backups *taken by hand* are not involved in auto rotation conditions.


* Open the menu ``[[ Backups ]] >> Settings``
* Choose the Google disk and click on ``Save`` button
* Enter *Service Account File path*
* Enter *Google Drive Folder ID*
* Click on ``Save`` button and and come back to set up the feature
* Set up a new configuration [[ Backups ]] >> Dashboard >> Add Database
* Choose the Database in the database field
* Define the Storage service
* Encrypt your backup if you need, but do not forget the password
* Enter *Interval Number*, *Interval Unit*, *New execution Date*
* Select/unselect *"Active" checkbox*
* Click on ``Save``
* Go to ``[[ Backups ]] >> Dashboard``
* Click on ``New Backup`` in the appeared configuration

RESULT: Backup is stored in the Google drive.
*Note: Restore without additional downloading is available only for* `Odoo backup service <https://apps.odoo.com/apps/modules/12.0/odoo_backup_sh/>`__
Binary file removed odoo_backup_sh_google_disk/images/backup_google.jpg
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
25 changes: 21 additions & 4 deletions odoo_backup_sh_google_disk/static/description/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -101,10 +101,25 @@ <h3 class="oe_slogan">How it works</h3>
<div class="oe_span12">
<p class="oe_mt32">
<ul>
<li>Define the <i>Name</i> </li>
<li>Create the <i>Password</i> if you want to encrypt the Backup</li>
<li>Schedule Auto Backups</li>
<li>Set up how many backups to preserve for certain time frames</li>
<li>Open the menu <b>[[ Backups ]] >> Settings</b></li>
<li>Choose the Dropbox and click on ``Save`` button</li>
<li>Enter <i>Service Account File path</i></li>
<li>Enter <i>Google Drive Folder ID</i></li>
<li>Click on ``Save`` and come back to set up the feature</li>
</ul>
<div class="oe_demo oe_picture oe_screenshot">
<img src="google_drive_config.png"/>
</div>
<ul>
<li>Set up a new configuration <b>[[ Backups ]] >> Dashboard >> Add Database</b></li>
<li>Choose the Database in the database field</li>
<li>Define the Storage service</li>
<li>Encrypt your backup if you need, but do not forget the password</li>
<li>Enter <i>Interval Number</i>, <i>Interval Unit</i>, <i>New execution Date</i></li>
<li>Select/unselect <i>"Active" checkbox</i></li>
<li>Click on ``Save``</li>
<li>Go to ``[[ Backups ]] >> Dashboard``</li>
<li>Click on ``New Backup`` in the appeared configuration</li>
</ul>
</p>
<div class="oe_demo oe_picture oe_screenshot">
Expand All @@ -114,6 +129,8 @@ <h3 class="oe_slogan">How it works</h3>
</div>
</section>



<section class="oe_container oe_dark">
<div class="oe_row oe_spaced">
<div class="oe_span12">
Expand Down

0 comments on commit 28ba34a

Please sign in to comment.