Documentation

Installation

Set up Akeneo Exporter and connect your infrastructure.

Cloud SaaS — No Installation Required! Simply sign up and connect your database.

What You Need

Akeneo PIM
  • • Version 4.0+ with REST API enabled
  • • OAuth 2.0 credentials (Client ID, Secret)
  • • Read access to products, families, categories
Database
  • • MongoDB 4.4+ or PostgreSQL 12+
  • • Read/write permissions
  • • Network accessible from internet
Network
  • • Firewall allows Akeneo Exporter IPs
  • • SSL/TLS encryption recommended
Storage
  • • ~5-10 KB per product
  • • Scale based on catalog size
Not sure about your Akeneo version?
Check in System → About. Akeneo 3.x users should upgrade to 4.0+ for optimal compatibility.

Database Setup

Your data stays in your own database — we never store your product data. Collections/tables are created automatically on first export using upsert operations.

🍃

MongoDB

bash
# Create database user with readWrite on all collections
db.createUser({
  user: "akeneo_exporter",
  pwd: "your_secure_password",
  roles: [{ role: "readWrite", db: "your_database" }]
})

# Collections created automatically:
# - products, product_parents
# - reference_categories, reference_categories_tmp
# - reference_attributes, reference_attributes_tmp
# - reference_entity_records, reference_entity_records_tmp

Atlas Users: Create user in Database Access, configure Network Access for our IPs.

🐘

PostgreSQL

sql
CREATE DATABASE your_database;
CREATE USER akeneo_exporter
  WITH PASSWORD 'your_secure_password';
GRANT ALL PRIVILEGES ON DATABASE your_database
  TO akeneo_exporter;

-- PostgreSQL 15+ (stricter permissions)
GRANT ALL ON SCHEMA public TO akeneo_exporter;

-- Tables created automatically:
-- products, product_parents
-- reference_categories, reference_categories_tmp
-- reference_attributes, reference_attributes_tmp
-- reference_entity_records, reference_entity_records_tmp

Cloud Users: Configure security groups to allow port 5432 from our IPs.

Network Configuration

Whitelist our static IP addresses in your database firewall to allow secure connections.

🌐

IP Addresses to Whitelist

US-East Region
203.0.113.10
203.0.113.11
EU-West Region
203.0.113.20
203.0.113.21

Note: Contact support for actual IP addresses. These are placeholders.

Security Best Practices

🔐Strong Passwords

16+ characters with mixed case, numbers, and symbols. Use a password manager.

🔒Enable SSL/TLS

Use sslmode=require (PostgreSQL) or ssl=true (MongoDB).

👤Minimal Permissions

Grant only readWrite access. Never use admin or root accounts.

🛡️IP Whitelisting

Only allow our IPs. Block all other inbound traffic on database ports.

🔄Rotate Credentials

Change passwords every 90 days. Update config after rotation.

📊Monitor Access Logs

Enable audit logging. Review regularly for suspicious activity.

🗂️Separate Environments

Use different databases for prod/staging with separate credentials.

💾Encrypt at Rest

Enable database encryption for compliance with data regulations.

Testing Your Setup

Verify all connections before your first export using built-in testing tools.

1
Configure Akeneo Source

Navigate to Configurations → New Configuration. Enter URL, Client ID, Secret, Username, Password.

2
Test Akeneo Connection

Click "Test Akeneo Connection" — success message or specific error details.

3
Configure Database Destination

Select database type, enter connection URI, specify database name.

4
Test Database Connection

Click "Test Database Connection" — verifies connectivity and write permissions.

5
Save Configuration

Both tests pass? Click "Save Configuration" to proceed.

Ready to Export! Green checkmarks confirm successful connections. If tests fail, check the Connection Errors guide.