Skip to content

Commit d73d3a3

Browse files
committed
Merge branch 'master' into dam-integration-with-dxp
2 parents 98e23f0 + e2b9639 commit d73d3a3

File tree

1 file changed

+33
-52
lines changed

1 file changed

+33
-52
lines changed

docs/dam/integration_with_dxp.md

Lines changed: 33 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -1,81 +1,63 @@
11
---
2-
description: Integrate DAM with your Ibexa DXP project to use an effective tool for managing media assets.
2+
description: Integrate DAM with your Ibexa DXP project to use an effective tool for managing marketing assets.
33
---
44

55

66
# Integrate DAM with DXP
77

8+
DAM integration with [[= product_name =]] is dedicated to [[= product_name_base =]] users who also use Actito services. It enables using assets repository stored in the DXP in the Actito platform to build and insert marketing assets into campaign emails.
9+
For more information, see [Actito documentation](https://cdn3.actito.com/fe/actito-documentation/docs/Using_Assets_from_a_DAM/#connection-to-ibexa).
10+
811
## Enable Elasticsearch or Solr
912

10-
A search engine is an important component of the DAM. To ensure proper indexing and search results, DAM requires one of
13+
To ensure proper indexing and search results, DAM requires one of
1114
the following search engines on your server:
1215

13-
- Elasticsearch
14-
- Solr
15-
16-
To install and configure search engine of your choice, go to [Elasticsearch documentation](search/search_engines/elastic_search/install_elastic_search.md)
17-
or to [Solr documentation](search/search_engines/solr_search_engine/install_solr.md)
16+
- [Elasticsearch](install_elastic_search.md)
17+
- [Solr](install_solr.md)
1818

1919

2020
## Enable OAuth Servers
2121

22-
Next, enable 0Auth Server authentication. To do it, follow steps to the Client section.
23-
https://doc.ibexa.co/en/latest/users/oauth_server/.
22+
Next, enable 0Auth Server authentication. To do it, follow steps up to the [Client section](oauth_server.md).
2423

2524
## Install DAM package
2625

2726
Install dedicated DAM `ibexa/dam-user` package into your [[= product_name =]] instance.
2827

29-
Run `composer require ibexa/dam-user`.
30-
31-
Add the `ibexa_dam_oauth2_client_user` table to the database:
32-
33-
`php bin/console ibexa:doctrine:schema:dump-sql vendor/ibexa/dam-user/src/bundle/Resources/config/schema.yaml | mysql -u <username> -p <database_name>`
34-
35-
Add technical users to your [[= product_name =]] instance.
36-
37-
Import migration file:
38-
`php bin/console ibexa:migrations:import vendor/ibexa/dam-user/src/bundle/Resources/migrations/2024_07_11_09_10_dam_technical_users.yaml`
39-
40-
Run migrations:
41-
`php bin/console ibexa:migrations:migrate`.
42-
43-
Two new user roles and users should be now in the Back Office.
28+
To install, run the following command:
4429

45-
Create OAuth2 client for the DXP user:
30+
```bash
31+
composer require ibexa/dam-user
32+
```
4633

47-
`php bin/console ibexa:dam:create-oauth2-client <client-name> <user-identifier>`.
34+
Add the `ibexa_dam_oauth2_client_user` table to the database:
4835

36+
```bash
37+
php bin/console ibexa:doctrine:schema:dump-sql vendor/ibexa/dam-user/src/bundle/Resources/config/schema.yaml | mysql -u <username> -p <database_name>
38+
```
4939

40+
Next, add technical users, required by DAM to your [[= product_name =]] instance.
5041

51-
<!-- Create database tables for `ibexa_0auth_server`:
42+
To do it, first, import the migration file:
5243

53-
```sql
54-
CREATE TABLE `ibexa_dam_oauth2_client_user` (
55-
`id` int(11) NOT NULL AUTO_INCREMENT,
56-
`client_id` int(11) NOT NULL,
57-
`user_id` int(11) NOT NULL,
58-
`created_at` datetime NOT NULL,
59-
`expires_at` datetime DEFAULT NULL,
60-
PRIMARY KEY (`id`),
61-
KEY `ibexa_oauth2_client_id` (`client_id`),
62-
KEY `ibexa_user_id` (`user_id`),
63-
CONSTRAINT `FK_CDDB196119EB6921` FOREIGN KEY (`client_id`) REFERENCES `ibexa_oauth2_client` (`id`) ON DELETE CASCADE ON UPDATE CASCADE,
64-
CONSTRAINT `FK_CDDB1961A76ED395` FOREIGN KEY (`user_id`) REFERENCES `ezuser` (`contentobject_id`) ON DELETE CASCADE ON UPDATE CASCADE
65-
) ENGINE=InnoDB AUTO_INCREMENT=4 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_unicode_520_ci;
44+
```bash
45+
php bin/console ibexa:migrations:import vendor/ibexa/dam-user/src/bundle/Resources/migrations/2024_07_11_09_10_dam_technical_users.yaml
6646
```
6747

68-
run migration file (migracja po zainstalowaniu paczki powinna tu trafic)
69-
70-
### Create and map user
48+
Next, run migrations:
7149

72-
DAM requires two user roles,
73-
You need to have two new types of users: creator and reader users (editors)
50+
```bash
51+
php bin/console ibexa:migrations:migrate
52+
```
7453

54+
Two new user roles and users should be now visibile in the Back Office.
7555

76-
### Install dedicated DAM support package
56+
Create OAuth2 client for the DXP user:
7757

78-
### Run migration -->
58+
```bash
59+
php bin/console ibexa:dam:create-oauth2-client <client-name> <user-identifier>
60+
```
7961

8062
## Override admin-ui
8163

@@ -175,14 +157,13 @@ nelmio_cors.options_provider.config:
175157
priority: 255
176158
```
177159

178-
and set the location id to 51
179-
160+
Set the `location ID` to `51`.
180161
```yaml
181162
parameters:
182163
ibexa.dam_app.image.root_location_id: 51
183164
```
184165

185-
Add DAM ConfigProvider:
166+
Add DAM `ConfigProvider`:
186167

187168
```yaml
188169
app.config.provider.dam_app:
@@ -194,6 +175,6 @@ app.config.provider.dam_app:
194175
- { name: ibexa.admin_ui.config.provider, key: 'damApp' }
195176
```
196177

197-
!!! important
178+
!!! caution
198179

199-
location 51
180+
Location ID must be set to 51, if you provide different location ID, your asset library won't be accessible from DAM.

0 commit comments

Comments
 (0)