Skip to content

Commit d292b5b

Browse files
raktima-opensignlabsraktima-opensignlabs
authored
Merge pull request #2012 from pravinOpenSign/patch-42
Patch 42
2 parents 1c70e4c + d868fdf commit d292b5b

9 files changed

Lines changed: 513 additions & 0 deletions

File tree

‎docs/docs/help/User Menu/Console/_category_.json‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,8 @@
1+
{
2+
"label": "Console",
3+
"position": 1,
4+
"link": {
5+
"type": "generated-index",
6+
"description": "The console application is accessible only to the admin; other users do not have access to it."
7+
}
8+
}

‎docs/docs/help/User Menu/Console/analystics.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
sidebar_position: 1
3+
title: Analytics
4+
---
5+
6+
### **Documents Signed**
7+
Displays the total number of documents you have signed.
8+
9+
---
10+
11+
### **Templates Count**
12+
Shows the total number of templates you have created.
13+
14+
---
15+
16+
### **Emails Sent**
17+
Indicates the total number of emails you have sent.
18+
19+
---
20+
21+
### **Storage Used**
22+
Displays the total amount of storage space you have utilized.
23+
24+
---
25+
26+
If you need further assistance, please contact our support team at **support@opensignlabs.com**.

‎docs/docs/help/User Menu/Console/branding.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
sidebar_position: 4
3+
title: Branding
4+
---
5+
6+
# 🔧 Branding
7+
8+
## **Custom Subdomain**
9+
This page is accessible only to **Enterprise** users. Here, users can configure their own custom subdomain and access the OpenSign application directly through it.
10+
11+
---
12+
13+
## **App Name**
14+
Users can set a custom application name to reflect their brand identity.
15+
This name will appear in custom template page titles and other areas across the application, helping maintain consistent branding.
16+
17+
---
18+
19+
## **App Logo**
20+
Users can upload their own logo to display within the application instead of the default OpenSign logo, reinforcing their brand presence.

‎docs/docs/help/User Menu/Console/custom_filestorage.md‎

Lines changed: 94 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,94 @@
1+
---
2+
sidebar_position: 5
3+
title: Custom File Storage
4+
---
5+
6+
# 💾 Custom File Storage
7+
8+
## 🌩️ Introduction to BYOC (Bring Your Own Cloud)
9+
10+
OpenSign supports **BYOC (Bring Your Own Cloud)** — allowing you to **store your documents in your own cloud storage** instead of OpenSign’s default storage.
11+
12+
With BYOC, organizations and users gain **greater control, privacy, and compliance flexibility** by connecting their preferred cloud providers such as **AWS S3** or **DigitalOcean Spaces**.
13+
14+
> 🧠 **Why BYOC?**
15+
> - Maintain complete ownership and control of your documents.
16+
> - Comply with internal, regional, or client-specific data policies.
17+
> - Choose your preferred cloud region or provider for better performance and compliance.
18+
19+
---
20+
21+
## 🚀 How to Access the Custom File Storage Setup
22+
23+
Follow the steps below to navigate to the **Custom File Storage** setup page in OpenSign:
24+
25+
1. Log in to your **OpenSign** account using an **Admin account**.
26+
2. Click on your **profile menu** (top-right corner) and select **Console**.
27+
3. In the **left sidebar**, go to **Storage**.
28+
29+
<img width="1722" height="814" alt="Custom file storage" src="https://github.com/user-attachments/assets/813f6685-3f36-40e4-aaaf-0d8b86bdc3b7" />
30+
31+
You will now be on the **Custom File Storage** setup page where you can configure your own storage provider.
32+
33+
> 🔒 **Note:** Access to Custom File Storage settings is available only to **Admin users**. Regular users will not see this option in their menu.
34+
35+
---
36+
37+
## 🔔 Set Up File Storage
38+
39+
By default, all users are connected to **OpenSign’s default file storage**.
40+
If you prefer to use your **own custom cloud storage (BYOC)**, you can easily configure it here.
41+
42+
You can set up an **AWS S3 bucket** or **DigitalOcean Space** to store your uploaded documents securely.
43+
To configure OpenSign with your cloud storage, refer to this detailed guide:
44+
👉 [Cloud Storage Setup Guide](https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3)
45+
46+
---
47+
48+
### 🪣 Steps to Configure Custom Storage
49+
50+
1. Click the **Add New** button.
51+
52+
<img width="861" height="408" alt="Add new workspace" src="https://github.com/user-attachments/assets/0f734c6a-e2ac-445a-8194-746b9c202f0a" />
53+
54+
2. Fill in the following details:
55+
56+
- **Unique File Adapter Name:** Enter a unique name for your storage configuration.
57+
- **Storage Provider:** Choose your provider — currently, OpenSign supports **AWS S3** and **DigitalOcean Spaces**.
58+
- **Bucket Name:** Specify your storage bucket name.
59+
- **Region:** Enter the region where your bucket is hosted.
60+
- **Endpoint:** Provide the endpoint URL of your storage service.
61+
- **Base URL:** Enter the base URL used to access stored files.
62+
- **Access Key ID:** Enter your storage access key ID.
63+
- **Secret Access Key:** Enter your storage secret access key.
64+
65+
3. Once all details are filled, click **Save and Activate** to enable your custom file storage.
66+
67+
After activation:
68+
- All your documents will be stored in the configured **BYOC storage provider**.
69+
- You will be automatically logged out to clear any previous file adapter data from your local session.
70+
- Upon logging in again, your custom file storage will be active, and all future documents will be saved there.
71+
72+
<img width="861" height="408" alt="custom file storage" src="https://github.com/user-attachments/assets/1add417d-f745-4e00-8cf3-7dcd9798f4db" />
73+
74+
---
75+
76+
### ⚠️ Important Note
77+
78+
In some cases, documents stored in your **custom (BYOC)** file storage may not load in OpenSign due to **CORS (Cross-Origin Resource Sharing)** policy restrictions.
79+
If you’ve activated custom file storage, ensure your cloud configuration **allows OpenSign to access your documents** and does **not block requests** due to CORS errors.
80+
81+
👉 [Read the article to learn how to set up CORS policies](https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3)
82+
83+
---
84+
85+
## 💬 Need Help?
86+
87+
If you need help setting up or testing your BYOC or custom file storage integration, contact our support team at
88+
📩 **[support@opensignlabs.com](mailto:support@opensignlabs.com)**
89+
90+
Or join our community for instant assistance:
91+
💬 [Join our Discord](https://discord.com/invite/xe9TDuyAyj)
92+
93+
**Happy Signing with OpenSign™!**
94+

‎docs/docs/help/User Menu/Console/emails.md‎

Lines changed: 61 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,61 @@
1+
---
2+
sidebar_position: 5
3+
title: Email Templates
4+
---
5+
6+
# 📧 Company Email Template Settings
7+
8+
This page allows the **admin user** to configure and manage customized email templates at the **organization level**.
9+
If you prefer not to grant users permission to set up their own email templates, you can define a single set of templates here that will apply to all users within your organization.
10+
11+
---
12+
13+
## 🧩 Set Up Custom Email Templates at the Organization Level
14+
15+
**Step 1:** Log in to your OpenSign account using valid credentials (**admin access required**).
16+
**Step 2:** Navigate to the **Profile Menu** and click on **Console**.
17+
**Step 3:** Go to the **Email** tab. Here, admin users can create, edit, and manage organization-level email templates.
18+
19+
<img width="800" alt="custom email templates" src="https://github.com/user-attachments/assets/b2fd3497-3e2b-4acc-b8a5-09bad8a5e5ba"></img>
20+
21+
---
22+
23+
## ✉️ Request Signature Email
24+
25+
This email is automatically sent to all signers when a document is shared for signing.
26+
27+
- Customize the **subject line**, **greeting**, **message body**, and **footer** to match your brand’s tone and style.
28+
- Use dynamic placeholders like `{{document_title}}`, `{{receiver_name}}`, and `{{signing_url}}` for personalization.
29+
- Personalized messages increase open rates and help recipients clearly understand the signing request.
30+
31+
---
32+
33+
## 📩 Document Completion Email
34+
35+
This email is sent to all signers and the document owner once the signing process is successfully completed.
36+
37+
- Contains a summary message along with the **signed document** and **completion certificate** as attachments.
38+
- Customizing this template helps maintain brand consistency even in post-signature communications.
39+
- Ideal for sharing **legal confirmations**, **audit trails**, or **record-keeping** updates.
40+
41+
---
42+
43+
### 🔄 Reset Template Text
44+
45+
Click the **Reset** button to restore any modified email template back to its **default OpenSign version**.
46+
After resetting, make sure to click **Save** to apply the changes.
47+
48+
---
49+
50+
## 🛠️ Additional Notes
51+
52+
- All custom email templates support **rich text formatting** and **dynamic variables**.
53+
- Updates take effect immediately and apply to **all new documents** created after the change.
54+
- Organizations can enforce consistent branding and compliance across all user emails.
55+
- If no custom email template is configured, and users are not allowed to create individual templates, OpenSign will automatically use the **OpenSign default email templates**.
56+
57+
> 💡 **Tip:** Always preview your templates before saving to ensure correct formatting and placeholder usage.
58+
59+
---
60+
61+
For further assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.

‎docs/docs/help/User Menu/Console/general.md‎

Lines changed: 58 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,58 @@
1+
---
2+
sidebar_position: 2
3+
title: General
4+
---
5+
6+
# General Settings
7+
8+
The **General Settings** section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.
9+
10+
---
11+
12+
## 🚀 How to Access the General Settings Page
13+
14+
1. Log in to your **OpenSign** account using an **Admin account**.
15+
2. Click on your **profile menu** (top-right corner) and select **Console**.
16+
3. From the **left sidebar**, choose **General**.
17+
18+
You’ll now be on the **General Settings** page.
19+
20+
> 🔒 **Note:** The **General Settings** page is available only to **Admin users**. Regular users will not see this option in their menu.
21+
22+
---
23+
24+
## Enabled Signature Types
25+
26+
Admins can define which signature types are available across the organization.
27+
28+
All users under your account will only have access to the signature methods you enable here in their **Preferences**. Any disabled methods will be hidden from their options.
29+
30+
**Example:**
31+
If Adam, the admin of your organization, disables the **Typed** signature type in the **Manage Signature Types** section, Ursula (a team member) will no longer see the **Typed** signature option in her preferences.
32+
33+
However, Ursula can still enable or disable any of the remaining signature types for each document she creates.
34+
When she sends a document to Sofia (a signer), Sofia will only be able to use the signature methods that Ursula selected during the document setup.
35+
36+
> **Note:** Managing **Signature Types** at the organization level is available in the Teams and Enterprise plans.
37+
> This feature is not included in the **Professional** or **Free** plans.
38+
39+
<img width="918" alt="General settings" src="https://github.com/user-attachments/assets/60681095-6e53-4667-9f47-b3d4d38ab4b3" />
40+
41+
---
42+
43+
## Allow Indexing of Public Profile
44+
45+
When this option is enabled, user's public profiles will be indexed by search engines and may appear in search results.
46+
47+
---
48+
49+
## Email Template Customization
50+
51+
This setting determines whether team members can create and manage their own email templates.
52+
53+
- If **disabled**, users **cannot** create or modify custom templates for signature requests or completion notifications.
54+
- If **enabled**, users can design and manage their own personalized email templates.
55+
56+
---
57+
58+
Need help? [Join our Discord community](https://discord.com/invite/xe9TDuyAyj) for instant support.

‎docs/docs/help/User Menu/Console/orgadmin.md‎

Lines changed: 106 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,106 @@
1+
---
2+
sidebar_position: 8
3+
title: Org Admins
4+
---
5+
6+
# 👥 Org Admins
7+
8+
The **Org Admins** section allows administrators to manage organization-level admin users within **OpenSign**.
9+
Org Admins are responsible for managing users, templates, and signing workflows for their organizations.
10+
11+
---
12+
13+
## 🚀 How to Access the Org Admins Page
14+
15+
1. Log in to your **OpenSign** account using an **Admin account**.
16+
2. Click on your **profile menu** (top-right corner) and select **Console**.
17+
3. From the **left sidebar**, expand the **Teams** menu.
18+
4. Click on **Org Admins**.
19+
20+
You’ll now see the **Org Admins Management Panel**, which displays all existing organization admins and seat usage.
21+
22+
> 🔒 **Note:** The **Org Admins** page is accessible only to **Admin users**. Regular users will not see this option in their menu.
23+
24+
---
25+
26+
## 🧾 Org Admins Overview
27+
28+
The **Org Admins** table lists all organization admins along with their key details:
29+
30+
- **Sr.No** — Serial number.
31+
- **Name** — Full name of the Org Admin.
32+
- **Email** — Registered email address.
33+
- **Organization** — Associated organization.
34+
- **IsActive** — Toggle to activate or deactivate an Org Admin.
35+
- **🗑️ Delete** — Remove an Org Admin permanently.
36+
37+
> ⚠️ **Caution:** Deactivating an Org Admin restricts their access without deleting their data.
38+
> Deleting permanently removes their access and data cannot be recovered.
39+
40+
---
41+
42+
## 🪙 Available Seats
43+
44+
At the bottom-right corner of the Org Admins page, you will find the **Available Seats** indicator.
45+
46+
47+
- **Example:** `Available seats: 2/5
48+
- **2** — Indicates the number of seats currently in use.
49+
- **5** — Represents the total number of seats purchased.
50+
51+
This helps you monitor how many Org Admin accounts can still be added under your current subscription.
52+
53+
> 💡 **Tip:** Once all available seats are used, you can purchase additional seats using the **Buy more users** option.
54+
55+
---
56+
57+
## ➕ Add a New Org Admin
58+
59+
To create a new organization admin:
60+
61+
1. Click the **➕ (Add)** icon at the top-right corner of the Org Admins page.
62+
2. The **Add User** popup will appear.
63+
64+
### 🧩 Add User Fields
65+
66+
- **Name** — Enter the Org Admin’s full name (Required).
67+
- **Email** — Enter a valid email address (Required).
68+
- **Password** — A random password will be auto-generated.
69+
- ⚠️ Copy and share it securely with the user — it will not be visible again.
70+
- **Phone** — Optional field.
71+
- **Organization** — Select the organization this user belongs to.
72+
- **Remaining Users** — Displays how many more admins can be added under your available seats.
73+
74+
Click **Submit** to create the Org Admin.
75+
76+
---
77+
78+
## 💳 Buy More Users (Add Seats)
79+
80+
If you’ve reached your seat limit, you can buy more user seats to add additional Org Admins.
81+
82+
1. Click on **Buy more users ➕** located at the top-right of the Org Admins page.
83+
2. The **Add Seats** popup will appear.
84+
85+
86+
### 🧾 Add Seats Fields
87+
88+
- **Quantity of users** — Enter the number of additional seats you want to purchase. *(Required)*
89+
- **Price** — Automatically calculated based on the number of users selected (e.g., `1 * 20 = $ 20`).
90+
91+
Click **Proceed** to continue with the purchase.
92+
93+
### 💬 Help Text for Add Seats Popup
94+
95+
> - The price updates automatically based on the number of seats entered.
96+
> - Once payment is successful, your **Available Seats** count updates in real-time.
97+
> - You can then add new Org Admins under the increased seat capacity.
98+
99+
---
100+
101+
## 💬 Need Help?
102+
103+
If you face any issues while managing Org Admins or purchasing seats, feel free to reach out to our support team:
104+
📩 **[support@opensignlabs.com](mailto:support@opensignlabs.com)**
105+
106+
**Empower your organization’s admins with OpenSign™!**

0 commit comments

Comments
 (0)