-
Notifications
You must be signed in to change notification settings - Fork 11.8k
[ADD] website_generator: add import tool documentation #18313
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Closed
Closed
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -13,3 +13,4 @@ Websites | |
| websites/forum | ||
| websites/blog | ||
| websites/livechat | ||
| websites/website_import_tool | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,141 @@ | ||
| =================== | ||
| Website Import Tool | ||
| =================== | ||
|
|
||
| The **Website Import Tool** recreates an existing website inside Odoo by fetching its pages and rebuilding | ||
| them as Odoo website pages. Images, sitemap, header, and footer are also imported. Optionally, | ||
| products and blog posts can be imported at the same time. | ||
|
|
||
| The tool converts pages into standard Odoo building blocks so the result is fully editable in Odoo. | ||
| It is not a pixel-perfect clone, and some manual adjustments may be needed after import. | ||
|
|
||
| .. warning:: | ||
|
|
||
| By using this tool, you confirm that you own the website and all its associated content (such as | ||
| images), and you take full responsibility for their use and any potential legal implications. | ||
|
|
||
| Getting There | ||
| ------------- | ||
|
|
||
| Go to **Settings ▸ Website ▸ Import Website**. | ||
|
|
||
| Filling in the Form | ||
| ------------------- | ||
|
|
||
| **Website URL** | ||
| Paste the address of the site you want to import (e.g. ``https://www.example.com``). | ||
| The limit for the number of pages is 500. If you need more, reach out to https://www.odoo.com/help | ||
|
|
||
| **Import products** | ||
| Turn this on if your website sells products and you want them imported into your Odoo shop. | ||
| The required module is installed automatically. By default, all products found will be imported. | ||
|
chrisdt1998 marked this conversation as resolved.
|
||
| For some eCommerce platforms, the import tool requires an API key in order to access all the | ||
| products information. | ||
|
|
||
| Currently, we support product imports from: | ||
|
|
||
| - Metadata | ||
| - WooCommerce (API key required) | ||
| - Shopify | ||
| - :ref:`PrestaShop <website_import_tool/prestashop>` (API key required) | ||
|
|
||
| **Import blogs** | ||
| Turn this on to import your blogs. The required module is installed automatically. | ||
| By default, all blogs found will be imported. For some blog platforms, the tool requires an API | ||
| key in order to access all the blogs information. | ||
|
|
||
| Currently, we support blog imports from: | ||
|
|
||
| - WordPress | ||
| - :ref:`Ghost <website_import_tool/ghost>` (API key required) | ||
|
|
||
| Submitting the Request | ||
| ---------------------- | ||
|
|
||
| To submit the request, click on **Import my website**. Once the request is finished, you will receive an email or notification | ||
| with some information about the number of pages, products and blogs imported. | ||
|
|
||
| .. _website_import_tool/prestashop: | ||
|
|
||
| PrestaShop | ||
| ---------- | ||
|
|
||
| **Creating an API key** | ||
|
|
||
| To import PrestaShop products, you will need to turn on the Webservice setting and provide an API | ||
| key. For all versions from PrestaShop 1.7 and up, the process of creating an API key is the same. | ||
|
|
||
| 1. Go to your website settings, e.g., ``https://example.com/admin1`` | ||
|
|
||
| 2. Navigate to *Advanced Parameters* | ||
|
|
||
| .. image:: website_import_tool/prestashop-advanced-parameters.png | ||
| :alt: Advanced Parameters | ||
|
|
||
| 3. Click *Webservice* | ||
|
|
||
| .. image:: website_import_tool/prestashop-webservice.png | ||
| :alt: Webservice | ||
|
|
||
| 4. *Enable PrestaShop's webservice* | ||
|
|
||
| .. image:: website_import_tool/prestashop-toggle-webservice.png | ||
| :alt: Enable PrestaShop's webservice | ||
|
|
||
| 5. *Add new webservice key* | ||
|
|
||
| .. image:: website_import_tool/prestashop-create-api-key.png | ||
| :alt: Add new webservice key | ||
|
|
||
| 6. Set the permissions. Below are the permissions required. If any are missing, it may not work as | ||
| expected. | ||
|
|
||
| .. list-table:: | ||
| :header-rows: 1 | ||
|
|
||
| * - Resource | ||
| - Method | ||
| * - categories | ||
| - GET | ||
| * - combinations | ||
| - GET | ||
| * - images | ||
| - GET | ||
| * - product_option_values | ||
| - GET | ||
| * - product_options | ||
| - GET | ||
| * - products | ||
| - GET | ||
|
|
||
| 7. Copy the API key and click save. | ||
|
|
||
| .. image:: website_import_tool/prestashop-api-key.png | ||
| :alt: Copy the API key and save | ||
|
|
||
| .. _website_import_tool/ghost: | ||
|
|
||
| Ghost | ||
| ----- | ||
|
|
||
| **Creating an API key** | ||
|
|
||
| To import blogs from your Ghost website, you will need to create an API key. To do this, follow the | ||
| steps on `Ghost Content API documentation <https://docs.ghost.org/content-api#key>`_. | ||
| Copy the *Content API key* into the import form to import your blogs. | ||
|
|
||
| Note that no permissions need to be set, the import tool only needs an API key that gives access to | ||
| public data. | ||
|
|
||
| Tips | ||
| ---- | ||
|
|
||
| - You can go to `Website Import Tool Trial <https://www.odoo.com/fr_FR/page/startwebsite>`_ to get a | ||
| fast sample of only 10 pages, ideal for a quick test. | ||
| - Creation of website pages is not mandatory, you can import the products and/or blogs | ||
| independently. | ||
| - If a page does not look right after import, you can edit it directly in the Odoo website builder | ||
| like any other page. | ||
| - Make sure your website is accessible and not protected by Cloudflare and/or other automated tool | ||
| countermeasures. | ||
| - For the best result, make sure you have your database updated to the most recent version of Odoo. | ||
Binary file added
BIN
+43.5 KB
...nt/applications/websites/website_import_tool/prestashop-advanced-parameters.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 added
BIN
+38.7 KB
content/applications/websites/website_import_tool/prestashop-api-key.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 added
BIN
+43.3 KB
content/applications/websites/website_import_tool/prestashop-create-api-key.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 added
BIN
+43.7 KB
content/applications/websites/website_import_tool/prestashop-toggle-webservice.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 added
BIN
+43.4 KB
content/applications/websites/website_import_tool/prestashop-webservice.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.