You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/en/account.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,29 @@
3
3
</div>
4
4
</div>
5
5
6
+
## Creating an account
7
+
8
+
### Sign up
9
+
10
+
If self-registration is enabled on your OpenHEXA instance, you can create an account directly from the sign-up page:
11
+
12
+
1. Navigate to the **Sign up** page.
13
+
2. Enter your email address.
14
+
3. Click **Sign up**.
15
+
4. Check your email inbox for a verification link.
16
+
5. Click the link to complete your registration (the link expires after 48 hours).
17
+
18
+
If you already have an account, click **Already have an account? Sign in** to go to the login page.
19
+
20
+
!!! info "Self-registration availability"
21
+
Self-registration may not be available on all OpenHEXA instances. If you see a message indicating that self-registration is disabled, contact your administrator to request an invitation.
22
+
23
+
### Accept an invitation
24
+
25
+
If you received an invitation to join a workspace, click the link in the invitation email to create your account and access the workspace.
26
+
27
+
## Managing your account
28
+
6
29
You can manage your personal information and security settings on the **Account** page in OpenHEXA.
Copy file name to clipboardExpand all lines: docs/en/admin.md
+23-5Lines changed: 23 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,13 @@
3
3
</div>
4
4
</div>
5
5
6
-
7
6
## Organization management
8
7
9
8
OpenHEXA uses a hierarchical structure where organizations contain multiple workspaces. The organization landing page serves as your control center for managing all aspects of your organization.
10
9
11
10
### Organization landing page
12
11
13
-
The organization landing page provides a comprehensive overview and management interface for your entire organization.
14
-
12
+
The organization landing page provides a comprehensive overview and management interface for your entire organization.
15
13
16
14
#### Key features
17
15
@@ -36,7 +34,6 @@ Organization Admins have comprehensive management capabilities across the entire
36
34
37
35
This role is essential for maintaining proper organizational structure and ensuring smooth operations across all workspaces.
38
36
39
-
40
37
#### 👤 Owner
41
38
42
39
Owners have the highest level of control over an organization. In addition to all Organization Admin capabilities, you can:
@@ -45,7 +42,28 @@ Owners have the highest level of control over an organization. In addition to al
45
42
- Assign Organization Admin roles
46
43
- Manage billing details and subscription plans (when applicable)
47
44
45
+
## External collaborators
46
+
47
+
External collaborators are users who have access to one or more workspaces within your organization but are not direct members of the organization itself. This is useful when you need to collaborate with partners, consultants, or other external stakeholders without granting them full organization membership.
48
+
49
+
### View external collaborators
50
+
51
+
Organization Admins and Owners can view all external collaborators from the organization settings:
52
+
53
+
1. Go to **Organization settings**.
54
+
2. Select the **External Collaborators** tab.
55
+
3. Browse the list of external collaborators, which shows.
56
+
57
+
### Manage external collaborators
58
+
59
+
Organization Admins and Owners can manage external collaborators:
60
+
61
+
-**Edit**: Update an external collaborator's workspace memberships or roles.
62
+
-**Remove**: Remove an external collaborator from all workspaces in the organization.
63
+
64
+
!!! info "Adding external collaborators"
65
+
External collaborators are added by inviting them to specific workspaces. When a user who is not an organization member accepts a workspace invitation, they automatically become an external collaborator.
48
66
49
67
## Organization switching
50
68
51
-
To learn how to switch between organizations, see [Switching organizations](navigation.md#switching-organizations) in the Navigation guide.
69
+
To learn how to switch between organizations, see [Switching organizations](navigation.md#switching-organizations) in the Navigation guide.
You can use the workspace database in OpenHEXA notebooks and OpenHEXA data pipelines.
19
19
20
20
You can also use your OpenHEXA workspace database as a data source in data visualization and BI tools like Tableau or Power BI. Simply copy the connection parameters from the database page and paste them into your tool.
21
21
22
+
## Database credentials
23
+
24
+
Each workspace provides two sets of database credentials:
25
+
26
+
### Read-only connection
27
+
28
+
The read-only connection is recommended for visualization tools like Superset, Power BI, Tableau, and other dashboard applications. This connection only allows `SELECT` queries, preventing accidental data modifications when exploring data.
29
+
30
+
The read-only credentials include:
31
+
32
+
-**Host**: The database server address
33
+
-**Port**: The connection port
34
+
-**Database name**: Your workspace database name
35
+
-**Username**: A read-only user (ending in `_ro`)
36
+
-**Password**: Auto-generated password
37
+
-**Connection URL**: A complete PostgreSQL connection string
38
+
39
+
### Read/write connection (full access)
40
+
41
+
The full access connection is intended for notebooks and pipelines that need to create, update, or delete data. Use these credentials when your code needs to write to the database.
42
+
43
+
!!! warning "Use read-only credentials for dashboards"
44
+
When connecting visualization tools, always use the read-only credentials. This prevents accidental data modifications and follows the principle of least privilege.
45
+
46
+
### Regenerate passwords
47
+
48
+
Workspace Admins can regenerate database passwords if they are compromised:
49
+
50
+
1. Go to **Settings** in your workspace.
51
+
2. In the **Database** section, click **Regenerate password** for the credentials you want to reset.
52
+
53
+
!!! warning "Password regeneration impact"
54
+
Regenerating a password will immediately invalidate the old password. Any tools or pipelines using the old credentials will need to be updated.
55
+
22
56
## Connect to Apache Superset
23
57
24
58
Apache Superset is a popular open-source data visualization and exploration platform. You can connect your OpenHEXA workspace database to Superset for advanced analytics and dashboard creation.
@@ -44,4 +78,3 @@ Apache Superset is a popular open-source data visualization and exploration plat
44
78
4.**Test and save**
45
79
- Click **Test Connection** to verify the setup.
46
80
- If successful, click **Connect** to save the database connection.
Copy file name to clipboardExpand all lines: docs/en/files.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -16,12 +16,12 @@ The file browser interface provides several key features:
16
16
- Search for files and folders by name
17
17
- Toggle visibility of hidden files (starting with ".")
18
18
- Create folders to organize your workspace (Editors and Admins only)
19
-
- Upload any type of file to your workspace (Editors and Admins only)
19
+
- Upload files or entire folders to your workspace (Editors and Admins only)
20
20
21
21
Files are displayed in a table showing:
22
22
23
23
- File/folder names with type icons
24
-
- File sizes in readable format
24
+
- File sizes in readable format
25
25
- Last modified dates with sorting capability
26
26
27
27
You can perform common file operations:
@@ -38,4 +38,4 @@ You can perform common file operations:
38
38
The workspace filesystem integrates seamlessly with other OpenHEXA components:
39
39
40
40
-**Notebooks**: Access files directly from Jupyter notebooks using the workspace filesystem. See [Notebooks](notebooks.md).
41
-
-**Data Pipelines**: Read and write files in your data processing workflows. See [OpenHEXA SDK](https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK).
41
+
-**Data Pipelines**: Read and write files in your data processing workflows. See [OpenHEXA SDK](https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-SDK).
Copy file name to clipboardExpand all lines: docs/en/pipelines.md
+8-12Lines changed: 8 additions & 12 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -77,8 +77,8 @@ For developers and data engineers, the CLI provides the most flexible approach:
77
77
78
78
See our guides: [Using the OpenHEXA CLI](https://github.com/BLSQ/openhexa/wiki/Using-the-OpenHEXA-CLI) and [Writing OpenHEXA Pipelines](https://github.com/BLSQ/openhexa/wiki/Writing-OpenHEXA-pipelines).
79
79
80
-
#### 2. From a Jupyter notebook
81
-
You can use a Notebook from the workspace file system to be run as a pipeline. This is the easiest way to create a pipeline:
80
+
#### 2. From a Jupyter notebook
81
+
You can use a Notebook from the workspace file system to be run as a pipeline. This is the easiest way to create a pipeline:
82
82
-**Quick start**: Transform exploratory analysis into production workflows
83
83
-**Limitations**: Notebook-based pipelines don't support input parameters
84
84
@@ -127,21 +127,21 @@ When you create a pipeline from a template, OpenHEXA maintains a connection betw
127
127
You can choose between two upgrade methods when creating a template-based pipeline:
128
128
129
129
-**Manual (Default)**: You control when to upgrade. Leave "Auto-update from template" disabled.
130
-
130
+
131
131
- Receive notifications about new versions
132
132
- Review changes between versions
133
133
- Upgrade using the "Upgrade to latest version" button
134
-
134
+
135
135
-**Automatic**: Pipeline automatically updates when template changes. Set "Auto-update from template" enabled.
136
-
136
+
137
137
- No manual intervention needed
138
138
- Pipeline stays in sync with template automatically
139
139
140
140
141
141
142
142
### Publish template pipelines
143
143
144
-
Pipeline creators can publish their own template pipelines to share with other users and workspaces.
144
+
Pipeline creators can publish their own template pipelines to share with other users and workspaces.
145
145
146
146
1.**Develop your pipeline**: Create and test your pipeline using standard development practices.
147
147
2.**Prepare documentation**: Ensure your pipeline has comprehensive documentation and clear parameter descriptions.
@@ -192,7 +192,7 @@ You can schedule pipelines to run automatically at specified intervals, enabling
192
192
!!! info "Common scheduling patterns"
193
193
194
194
- `0 0 * * *` - Run daily at midnight
195
-
- `0 0 * * MON` - Run every Monday at midnight
195
+
- `0 0 * * MON` - Run every Monday at midnight
196
196
- `0 0 1 * *` - Run on the first day of every month at midnight
197
197
- `0 */6 * * *` - Run every 6 hours
198
198
- `*/15 * * * *` - Run every 15 minutes
@@ -222,9 +222,5 @@ Set default parameter values that will be used for scheduled runs.
222
222
223
223
-**View and edit code**: Browse and modify pipeline source code directly in the web interface
224
224
-**Download**: Export pipeline code for local development or backup
Copy file name to clipboardExpand all lines: docs/fr/account.md
+23Lines changed: 23 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,6 +3,29 @@
3
3
</div>
4
4
</div>
5
5
6
+
## Créer un compte
7
+
8
+
### S'inscrire
9
+
10
+
Si l'auto-inscription est activée sur votre instance OpenHEXA, vous pouvez créer un compte directement depuis la page d'inscription :
11
+
12
+
1. Accédez à la page **S'inscrire**.
13
+
2. Entrez votre adresse e-mail.
14
+
3. Cliquez sur **S'inscrire**.
15
+
4. Vérifiez votre boîte de réception pour un lien de vérification.
16
+
5. Cliquez sur le lien pour terminer votre inscription (le lien expire après 48 heures).
17
+
18
+
Si vous avez déjà un compte, cliquez sur **Vous avez déjà un compte ? Se connecter** pour accéder à la page de connexion.
19
+
20
+
!!! info "Disponibilité de l'auto-inscription"
21
+
L'auto-inscription peut ne pas être disponible sur toutes les instances OpenHEXA. Si vous voyez un message indiquant que l'auto-inscription est désactivée, contactez votre administrateur pour demander une invitation.
22
+
23
+
### Accepter une invitation
24
+
25
+
Si vous avez reçu une invitation à rejoindre un espace de travail, cliquez sur le lien dans l'e-mail d'invitation pour créer votre compte et accéder à l'espace de travail.
26
+
27
+
## Gérer votre compte
28
+
6
29
Vous pouvez gérer vos informations personnelles et vos paramètres de sécurité sur la page **Compte** dans OpenHEXA.
Copy file name to clipboardExpand all lines: docs/fr/admin.md
+22-5Lines changed: 22 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,15 +3,13 @@
3
3
</div>
4
4
</div>
5
5
6
-
7
6
## Gestion de l'organisation
8
7
9
8
OpenHEXA utilise une structure hiérarchique où les organisations contiennent plusieurs espaces de travail. La page d'accueil de l'organisation sert de centre de contrôle pour gérer tous les aspects de votre organisation.
10
9
11
10
### Page d'accueil de l'organisation
12
11
13
-
La page d'accueil de l'organisation fournit un aperçu complet et une interface de gestion pour toute votre organisation.
14
-
12
+
La page d'accueil de l'organisation fournit un aperçu complet et une interface de gestion pour toute votre organisation.
15
13
16
14
#### Fonctionnalités clés
17
15
@@ -36,7 +34,6 @@ Les Admins de l'organisation ont des capacités de gestion complètes sur l'ense
36
34
37
35
Ce rôle est essentiel pour maintenir une structure organisationnelle appropriée et assurer des opérations fluides dans tous les espaces de travail.
38
36
39
-
40
37
#### 👤 Owner
41
38
42
39
Les Owners ont le plus haut niveau de contrôle sur une organisation. En plus de toutes les capacités d'Admin de l'organisation, vous pouvez :
@@ -45,8 +42,28 @@ Les Owners ont le plus haut niveau de contrôle sur une organisation. En plus de
45
42
- Attribuer des rôles d'Admin de l'organisation
46
43
- Gérer les détails de facturation et les plans d'abonnement (le cas échéant)
47
44
45
+
## Collaborateurs externes
46
+
47
+
Les collaborateurs externes sont des utilisateurs qui ont accès à un ou plusieurs espaces de travail au sein de votre organisation mais qui ne sont pas membres directs de l'organisation elle-même. Cela est utile lorsque vous devez collaborer avec des partenaires, des consultants ou d'autres parties prenantes externes sans leur accorder une adhésion complète à l'organisation.
48
+
49
+
### Voir les collaborateurs externes
50
+
51
+
Les Admins de l'organisation et les Owners peuvent voir tous les collaborateurs externes depuis les paramètres de l'organisation :
3. Parcourez la liste des collaborateurs externes.
56
+
57
+
### Gérer les collaborateurs externes
58
+
59
+
Les Admins de l'organisation et les Owners peuvent gérer les collaborateurs externes :
60
+
61
+
-**Modifier** : Mettez à jour les adhésions aux espaces de travail ou les rôles d'un collaborateur externe.
62
+
-**Supprimer** : Supprimez un collaborateur externe de tous les espaces de travail de l'organisation.
63
+
64
+
!!! info "Ajouter des collaborateurs externes"
65
+
Les collaborateurs externes sont ajoutés en les invitant à des espaces de travail spécifiques. Lorsqu'un utilisateur qui n'est pas membre de l'organisation accepte une invitation à un espace de travail, il devient automatiquement un collaborateur externe.
48
66
49
67
## Changement d'organisation
50
68
51
69
Pour apprendre comment basculer entre les organisations, consultez [Changement d'organisations](navigation.md#changer-dorganisation) dans le guide de Navigation.
Copy file name to clipboardExpand all lines: docs/fr/database.md
+35-3Lines changed: 35 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -11,14 +11,48 @@ Tous les membres de l'espace de travail peuvent parcourir les tables de la base
11
11
!!! info "Permissions de la base de données par rôle"
12
12
- **Viewers** : Peuvent parcourir les tables et visualiser les données, mais ne peuvent pas voir les identifiants de la base de données ni écrire dans la base de données
13
13
- **Editors** : Peuvent parcourir les tables, visualiser les données, accéder aux identifiants de la base de données et écrire dans la base de données
14
-
- **Admins** : Peuvent parcourir les tables, visualiser les données, accéder aux identifiants de la base de données, écrire dans la base de données et régénérer le mot de passe de la base de données
14
+
- **Admins** : Peuvent parcourir les tables, visualiser les données, accéder aux identifiants de la base de données, écrire dans la base de données et régénérer les mots de passe de la base de données
Vous pouvez utiliser la base de données de l'espace de travail dans les notebooks OpenHEXA et les pipelines de données OpenHEXA.
19
19
20
20
Vous pouvez également utiliser votre base de données d'espace de travail OpenHEXA comme source de données dans des outils de visualisation de données et de BI comme Tableau ou Power BI. Copiez simplement les paramètres de connexion de la page de base de données et collez-les dans votre outil.
21
21
22
+
## Identifiants de la base de données
23
+
24
+
Chaque espace de travail fournit deux jeux d'identifiants de base de données :
25
+
26
+
### Connexion en lecture seule
27
+
28
+
La connexion en lecture seule est recommandée pour les outils de visualisation comme Superset, Power BI, Tableau et autres applications de tableaux de bord. Cette connexion permet uniquement les requêtes `SELECT`, empêchant les modifications accidentelles des données lors de l'exploration.
29
+
30
+
Les identifiants en lecture seule incluent :
31
+
32
+
-**Hôte** : L'adresse du serveur de base de données
33
+
-**Port** : Le port de connexion
34
+
-**Nom de base de données** : Le nom de votre base de données d'espace de travail
35
+
-**Nom d'utilisateur** : Un utilisateur en lecture seule (se terminant par `_ro`)
36
+
-**Mot de passe** : Mot de passe généré automatiquement
37
+
-**URL de connexion** : Une chaîne de connexion PostgreSQL complète
38
+
39
+
### Connexion en lecture/écriture (accès complet)
40
+
41
+
La connexion avec accès complet est destinée aux notebooks et aux pipelines qui doivent créer, mettre à jour ou supprimer des données. Utilisez ces identifiants lorsque votre code doit écrire dans la base de données.
42
+
43
+
!!! warning "Utilisez les identifiants en lecture seule pour les tableaux de bord"
44
+
Lors de la connexion d'outils de visualisation, utilisez toujours les identifiants en lecture seule. Cela empêche les modifications accidentelles des données et respecte le principe du moindre privilège.
45
+
46
+
### Régénérer les mots de passe
47
+
48
+
Les Admins de l'espace de travail peuvent régénérer les mots de passe de la base de données s'ils sont compromis :
49
+
50
+
1. Accédez aux **Paramètres** de votre espace de travail.
51
+
2. Dans la section **Base de données**, cliquez sur **Régénérer le mot de passe** pour les identifiants que vous souhaitez réinitialiser.
52
+
53
+
!!! warning "Impact de la régénération du mot de passe"
54
+
La régénération d'un mot de passe invalidera immédiatement l'ancien mot de passe. Tous les outils ou pipelines utilisant les anciens identifiants devront être mis à jour.
55
+
22
56
## Se connecter à Apache Superset
23
57
24
58
Apache Superset est une plateforme populaire open-source de visualisation et d'exploration de données. Vous pouvez connecter votre base de données d'espace de travail OpenHEXA à Superset pour des analyses avancées et la création de tableaux de bord.
@@ -44,5 +78,3 @@ Apache Superset est une plateforme populaire open-source de visualisation et d'e
44
78
4.**Tester et enregistrer**
45
79
- Cliquez sur **Tester la connexion** pour vérifier la configuration.
46
80
- Si réussi, cliquez sur **Connecter** pour enregistrer la connexion de base de données.
0 commit comments