mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-07 02:07:40 +02:00
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Console",
|
||||
"position": 1,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "The console application is accessible only to the admin; other users do not have access to it."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,26 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Analytics
|
||||
---
|
||||
|
||||
### **Documents Signed**
|
||||
Displays the total number of documents you have signed.
|
||||
|
||||
---
|
||||
|
||||
### **Templates Count**
|
||||
Shows the total number of templates you have created.
|
||||
|
||||
---
|
||||
|
||||
### **Emails Sent**
|
||||
Indicates the total number of emails you have sent.
|
||||
|
||||
---
|
||||
|
||||
### **Storage Used**
|
||||
Displays the total amount of storage space you have utilized.
|
||||
|
||||
---
|
||||
|
||||
If you need further assistance, please contact our support team at **support@opensignlabs.com**.
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Branding
|
||||
---
|
||||
|
||||
# 🔧 Branding
|
||||
|
||||
## **Custom Subdomain**
|
||||
This page is accessible only to **Enterprise** users. Here, users can configure their own custom subdomain and access the OpenSign application directly through it.
|
||||
|
||||
---
|
||||
|
||||
## **App Name**
|
||||
Users can set a custom application name to reflect their brand identity.
|
||||
This name will appear in custom template page titles and other areas across the application, helping maintain consistent branding.
|
||||
|
||||
---
|
||||
|
||||
## **App Logo**
|
||||
Users can upload their own logo to display within the application instead of the default OpenSign logo, reinforcing their brand presence.
|
||||
@@ -0,0 +1,94 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Custom File Storage
|
||||
---
|
||||
|
||||
# 💾 Custom File Storage
|
||||
|
||||
## 🌩️ Introduction to BYOC (Bring Your Own Cloud)
|
||||
|
||||
OpenSign supports **BYOC (Bring Your Own Cloud)** — allowing you to **store your documents in your own cloud storage** instead of OpenSign’s default storage.
|
||||
|
||||
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**.
|
||||
|
||||
> 🧠 **Why BYOC?**
|
||||
> - Maintain complete ownership and control of your documents.
|
||||
> - Comply with internal, regional, or client-specific data policies.
|
||||
> - Choose your preferred cloud region or provider for better performance and compliance.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Access the Custom File Storage Setup
|
||||
|
||||
Follow the steps below to navigate to the **Custom File Storage** setup page in OpenSign:
|
||||
|
||||
1. Log in to your **OpenSign** account using an **Admin account**.
|
||||
2. Click on your **profile menu** (top-right corner) and select **Console**.
|
||||
3. In the **left sidebar**, go to **Storage**.
|
||||
|
||||
<img width="1722" height="814" alt="Custom file storage" src="https://github.com/user-attachments/assets/813f6685-3f36-40e4-aaaf-0d8b86bdc3b7" />
|
||||
|
||||
You will now be on the **Custom File Storage** setup page where you can configure your own storage provider.
|
||||
|
||||
> 🔒 **Note:** Access to Custom File Storage settings is available only to **Admin users**. Regular users will not see this option in their menu.
|
||||
|
||||
---
|
||||
|
||||
## 🔔 Set Up File Storage
|
||||
|
||||
By default, all users are connected to **OpenSign’s default file storage**.
|
||||
If you prefer to use your **own custom cloud storage (BYOC)**, you can easily configure it here.
|
||||
|
||||
You can set up an **AWS S3 bucket** or **DigitalOcean Space** to store your uploaded documents securely.
|
||||
To configure OpenSign with your cloud storage, refer to this detailed guide:
|
||||
👉 [Cloud Storage Setup Guide](https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3)
|
||||
|
||||
---
|
||||
|
||||
### 🪣 Steps to Configure Custom Storage
|
||||
|
||||
1. Click the **Add New** button.
|
||||
|
||||
<img width="861" height="408" alt="Add new workspace" src="https://github.com/user-attachments/assets/0f734c6a-e2ac-445a-8194-746b9c202f0a" />
|
||||
|
||||
2. Fill in the following details:
|
||||
|
||||
- **Unique File Adapter Name:** Enter a unique name for your storage configuration.
|
||||
- **Storage Provider:** Choose your provider — currently, OpenSign supports **AWS S3** and **DigitalOcean Spaces**.
|
||||
- **Bucket Name:** Specify your storage bucket name.
|
||||
- **Region:** Enter the region where your bucket is hosted.
|
||||
- **Endpoint:** Provide the endpoint URL of your storage service.
|
||||
- **Base URL:** Enter the base URL used to access stored files.
|
||||
- **Access Key ID:** Enter your storage access key ID.
|
||||
- **Secret Access Key:** Enter your storage secret access key.
|
||||
|
||||
3. Once all details are filled, click **Save and Activate** to enable your custom file storage.
|
||||
|
||||
After activation:
|
||||
- All your documents will be stored in the configured **BYOC storage provider**.
|
||||
- You will be automatically logged out to clear any previous file adapter data from your local session.
|
||||
- Upon logging in again, your custom file storage will be active, and all future documents will be saved there.
|
||||
|
||||
<img width="861" height="408" alt="custom file storage" src="https://github.com/user-attachments/assets/1add417d-f745-4e00-8cf3-7dcd9798f4db" />
|
||||
|
||||
---
|
||||
|
||||
### ⚠️ Important Note
|
||||
|
||||
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.
|
||||
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.
|
||||
|
||||
👉 [Read the article to learn how to set up CORS policies](https://docs.opensignlabs.com/docs/self-host/cloud-storage/s3)
|
||||
|
||||
---
|
||||
|
||||
## 💬 Need Help?
|
||||
|
||||
If you need help setting up or testing your BYOC or custom file storage integration, contact our support team at
|
||||
📩 **[support@opensignlabs.com](mailto:support@opensignlabs.com)**
|
||||
|
||||
Or join our community for instant assistance:
|
||||
💬 [Join our Discord](https://discord.com/invite/xe9TDuyAyj)
|
||||
|
||||
**Happy Signing with OpenSign™!**
|
||||
|
||||
@@ -0,0 +1,61 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Email Templates
|
||||
---
|
||||
|
||||
# 📧 Company Email Template Settings
|
||||
|
||||
This page allows the **admin user** to configure and manage customized email templates at the **organization level**.
|
||||
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.
|
||||
|
||||
---
|
||||
|
||||
## 🧩 Set Up Custom Email Templates at the Organization Level
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using valid credentials (**admin access required**).
|
||||
**Step 2:** Navigate to the **Profile Menu** and click on **Console**.
|
||||
**Step 3:** Go to the **Email** tab. Here, admin users can create, edit, and manage organization-level email templates.
|
||||
|
||||
<img width="800" alt="custom email templates" src="https://github.com/user-attachments/assets/b2fd3497-3e2b-4acc-b8a5-09bad8a5e5ba"></img>
|
||||
|
||||
---
|
||||
|
||||
## ✉️ Request Signature Email
|
||||
|
||||
This email is automatically sent to all signers when a document is shared for signing.
|
||||
|
||||
- Customize the **subject line**, **greeting**, **message body**, and **footer** to match your brand’s tone and style.
|
||||
- Use dynamic placeholders like `{{document_title}}`, `{{receiver_name}}`, and `{{signing_url}}` for personalization.
|
||||
- Personalized messages increase open rates and help recipients clearly understand the signing request.
|
||||
|
||||
---
|
||||
|
||||
## 📩 Document Completion Email
|
||||
|
||||
This email is sent to all signers and the document owner once the signing process is successfully completed.
|
||||
|
||||
- Contains a summary message along with the **signed document** and **completion certificate** as attachments.
|
||||
- Customizing this template helps maintain brand consistency even in post-signature communications.
|
||||
- Ideal for sharing **legal confirmations**, **audit trails**, or **record-keeping** updates.
|
||||
|
||||
---
|
||||
|
||||
### 🔄 Reset Template Text
|
||||
|
||||
Click the **Reset** button to restore any modified email template back to its **default OpenSign version**.
|
||||
After resetting, make sure to click **Save** to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Additional Notes
|
||||
|
||||
- All custom email templates support **rich text formatting** and **dynamic variables**.
|
||||
- Updates take effect immediately and apply to **all new documents** created after the change.
|
||||
- Organizations can enforce consistent branding and compliance across all user emails.
|
||||
- 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**.
|
||||
|
||||
> 💡 **Tip:** Always preview your templates before saving to ensure correct formatting and placeholder usage.
|
||||
|
||||
---
|
||||
|
||||
For further assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.
|
||||
@@ -0,0 +1,58 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: General
|
||||
---
|
||||
|
||||
# General Settings
|
||||
|
||||
The **General Settings** section in OpenSign provides key administrative settings to help you manage and control the overall configuration of your OpenSign platform.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Access the General Settings Page
|
||||
|
||||
1. Log in to your **OpenSign** account using an **Admin account**.
|
||||
2. Click on your **profile menu** (top-right corner) and select **Console**.
|
||||
3. From the **left sidebar**, choose **General**.
|
||||
|
||||
You’ll now be on the **General Settings** page.
|
||||
|
||||
> 🔒 **Note:** The **General Settings** page is available only to **Admin users**. Regular users will not see this option in their menu.
|
||||
|
||||
---
|
||||
|
||||
## Enabled Signature Types
|
||||
|
||||
Admins can define which signature types are available across the organization.
|
||||
|
||||
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.
|
||||
|
||||
**Example:**
|
||||
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.
|
||||
|
||||
However, Ursula can still enable or disable any of the remaining signature types for each document she creates.
|
||||
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.
|
||||
|
||||
> **Note:** Managing **Signature Types** at the organization level is available in the Teams and Enterprise plans.
|
||||
> This feature is not included in the **Professional** or **Free** plans.
|
||||
|
||||
<img width="918" alt="General settings" src="https://github.com/user-attachments/assets/60681095-6e53-4667-9f47-b3d4d38ab4b3" />
|
||||
|
||||
---
|
||||
|
||||
## Allow Indexing of Public Profile
|
||||
|
||||
When this option is enabled, user's public profiles will be indexed by search engines and may appear in search results.
|
||||
|
||||
---
|
||||
|
||||
## Email Template Customization
|
||||
|
||||
This setting determines whether team members can create and manage their own email templates.
|
||||
|
||||
- If **disabled**, users **cannot** create or modify custom templates for signature requests or completion notifications.
|
||||
- If **enabled**, users can design and manage their own personalized email templates.
|
||||
|
||||
---
|
||||
|
||||
Need help? [Join our Discord community](https://discord.com/invite/xe9TDuyAyj) for instant support.
|
||||
@@ -0,0 +1,106 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
title: Org Admins
|
||||
---
|
||||
|
||||
# 👥 Org Admins
|
||||
|
||||
The **Org Admins** section allows administrators to manage organization-level admin users within **OpenSign**.
|
||||
Org Admins are responsible for managing users, templates, and signing workflows for their organizations.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Access the Org Admins Page
|
||||
|
||||
1. Log in to your **OpenSign** account using an **Admin account**.
|
||||
2. Click on your **profile menu** (top-right corner) and select **Console**.
|
||||
3. From the **left sidebar**, expand the **Teams** menu.
|
||||
4. Click on **Org Admins**.
|
||||
|
||||
You’ll now see the **Org Admins Management Panel**, which displays all existing organization admins and seat usage.
|
||||
|
||||
> 🔒 **Note:** The **Org Admins** page is accessible only to **Admin users**. Regular users will not see this option in their menu.
|
||||
|
||||
---
|
||||
|
||||
## 🧾 Org Admins Overview
|
||||
|
||||
The **Org Admins** table lists all organization admins along with their key details:
|
||||
|
||||
- **Sr.No** — Serial number.
|
||||
- **Name** — Full name of the Org Admin.
|
||||
- **Email** — Registered email address.
|
||||
- **Organization** — Associated organization.
|
||||
- **IsActive** — Toggle to activate or deactivate an Org Admin.
|
||||
- **🗑️ Delete** — Remove an Org Admin permanently.
|
||||
|
||||
> ⚠️ **Caution:** Deactivating an Org Admin restricts their access without deleting their data.
|
||||
> Deleting permanently removes their access and data cannot be recovered.
|
||||
|
||||
---
|
||||
|
||||
## 🪙 Available Seats
|
||||
|
||||
At the bottom-right corner of the Org Admins page, you will find the **Available Seats** indicator.
|
||||
|
||||
|
||||
- **Example:** `Available seats: 2/5
|
||||
- **2** — Indicates the number of seats currently in use.
|
||||
- **5** — Represents the total number of seats purchased.
|
||||
|
||||
This helps you monitor how many Org Admin accounts can still be added under your current subscription.
|
||||
|
||||
> 💡 **Tip:** Once all available seats are used, you can purchase additional seats using the **Buy more users** option.
|
||||
|
||||
---
|
||||
|
||||
## ➕ Add a New Org Admin
|
||||
|
||||
To create a new organization admin:
|
||||
|
||||
1. Click the **➕ (Add)** icon at the top-right corner of the Org Admins page.
|
||||
2. The **Add User** popup will appear.
|
||||
|
||||
### 🧩 Add User Fields
|
||||
|
||||
- **Name** — Enter the Org Admin’s full name (Required).
|
||||
- **Email** — Enter a valid email address (Required).
|
||||
- **Password** — A random password will be auto-generated.
|
||||
- ⚠️ Copy and share it securely with the user — it will not be visible again.
|
||||
- **Phone** — Optional field.
|
||||
- **Organization** — Select the organization this user belongs to.
|
||||
- **Remaining Users** — Displays how many more admins can be added under your available seats.
|
||||
|
||||
Click **Submit** to create the Org Admin.
|
||||
|
||||
---
|
||||
|
||||
## 💳 Buy More Users (Add Seats)
|
||||
|
||||
If you’ve reached your seat limit, you can buy more user seats to add additional Org Admins.
|
||||
|
||||
1. Click on **Buy more users ➕** located at the top-right of the Org Admins page.
|
||||
2. The **Add Seats** popup will appear.
|
||||
|
||||
|
||||
### 🧾 Add Seats Fields
|
||||
|
||||
- **Quantity of users** — Enter the number of additional seats you want to purchase. *(Required)*
|
||||
- **Price** — Automatically calculated based on the number of users selected (e.g., `1 * 20 = $ 20`).
|
||||
|
||||
Click **Proceed** to continue with the purchase.
|
||||
|
||||
### 💬 Help Text for Add Seats Popup
|
||||
|
||||
> - The price updates automatically based on the number of seats entered.
|
||||
> - Once payment is successful, your **Available Seats** count updates in real-time.
|
||||
> - You can then add new Org Admins under the increased seat capacity.
|
||||
|
||||
---
|
||||
|
||||
## 💬 Need Help?
|
||||
|
||||
If you face any issues while managing Org Admins or purchasing seats, feel free to reach out to our support team:
|
||||
📩 **[support@opensignlabs.com](mailto:support@opensignlabs.com)**
|
||||
|
||||
**Empower your organization’s admins with OpenSign™!**
|
||||
@@ -0,0 +1,76 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
title: Organizations
|
||||
---
|
||||
|
||||
# 🏢 Organizations
|
||||
|
||||
The **Organizations** section in **OpenSign** allows administrators to create and manage **separate groups** within a **Team or Enterprise account**.
|
||||
Each organization acts as an **independent workspace** with its **own users, teams, templates, and signing workflows**.
|
||||
|
||||
---
|
||||
|
||||
## 🧩 What Are Organizations in OpenSign?
|
||||
|
||||
An **Organization** represents a **distinct sub-account** under your main (team or enterprise) OpenSign account.
|
||||
Organizations are completely **isolated** from each other — meaning:
|
||||
|
||||
- Teams and users from one organization **cannot view or access** teams, documents, or users from another organization.
|
||||
- Each organization functions as its own **secure workspace** within your overall account.
|
||||
- You can manage multiple organizations from a **single admin console**, ensuring centralized control.
|
||||
|
||||
### 💼 Example Use Case
|
||||
|
||||
If your company manages multiple **clients or departments**, each with its own teams and sub-users, the **Organizations** feature is perfect for you.
|
||||
|
||||
For example:
|
||||
- An agency can create **individual sub-accounts** for each client (Client A, Client B, etc.).
|
||||
- Each client’s team members and workflows remain **private and independent**.
|
||||
- The **main admin (enterprise account holder)** retains full control and visibility from the console.
|
||||
|
||||
> 💰 **Billing:** All organizations under the same account are billed centrally by the **primary account holder**.
|
||||
> This ensures simplified management and unified subscription handling.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 How to Set Up Organizations in OpenSign
|
||||
|
||||
1. Log in to your **OpenSign** account using an **Admin account**.
|
||||
2. Click on your **profile menu** (top-right corner) and select **Console**.
|
||||
3. Once the **Console app** opens, navigate to the left sidebar and expand the **Teams** menu.
|
||||
4. Click on **Organizations**.
|
||||
5. The **Organizations Management** panel will appear, displaying a list of existing organizations and the option to add new ones.
|
||||
|
||||
> 🔒 **Note:** The **Console** and **Organizations** pages are accessible only to **Admin users**.
|
||||
> Regular users will not see this option in their menu.
|
||||
|
||||
---
|
||||
|
||||
## ➕ Add a New Organization
|
||||
|
||||
To create a new organization:
|
||||
|
||||
1. Click the **➕ (Add)** icon at the top-right corner of the Organizations panel.
|
||||
2. In the **Add Organization** popup:
|
||||
- **Name** — Enter the name of your organization. *(Required)*
|
||||
3. Click **Submit** to save or **Reset** to clear the input.
|
||||
|
||||
> 💡 **Tip:** Use clear and descriptive names (e.g., *Client Alpha*, *Marketing Division*, *PS Inc.*)
|
||||
> for easier management and reporting.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ Manage Organizations
|
||||
|
||||
The **Organizations table** lists all existing organizations with the following details:
|
||||
|
||||
- **Sr.No** — Serial number of the organization.
|
||||
- **Name** — The registered name of the organization.
|
||||
- **IsActive** — Toggle to activate or deactivate the organization.
|
||||
|
||||
> ⚠️ **Note:** Deactivating an organization disables all its associated users and workflows until it is reactivated.
|
||||
|
||||
---
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,64 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: Custom Signing Certificate
|
||||
---
|
||||
|
||||
# 🔐 Custom Signing Certificate
|
||||
|
||||
The **Custom Signing Certificate** page allows you to upload and manage your own **digital signing certificate** (PFX format) for secure and verified document signing in OpenSign.
|
||||
|
||||
By default, OpenSign uses its **built-in signing certificate** to digitally sign documents.
|
||||
However, if your organization has its own **custom certificate (PFX or P12 format)**, you can upload and activate it here.
|
||||
<img width="1722" height="814" alt="pfx cerificate upload" src="https://github.com/user-attachments/assets/a5668f61-332d-49c5-ace2-5f0f92d3b68f" />
|
||||
|
||||
---
|
||||
|
||||
## 🪪 What is a PFX Certificate?
|
||||
|
||||
A **PFX** (or **P12**) certificate is a password-protected digital certificate file that contains:
|
||||
- A **private key** (used for signing documents securely)
|
||||
- A **public certificate** (used to verify the signature’s authenticity)
|
||||
|
||||
Using a custom certificate enhances trust and compliance by ensuring all signed documents carry your organization’s **digital identity**.
|
||||
|
||||
---
|
||||
|
||||
## ⚙️ How to Upload Your Custom Certificate
|
||||
|
||||
Follow these steps to set up your custom signing certificate:
|
||||
|
||||
1. **Log in** to your OpenSign account using your admin credentials.
|
||||
2. Navigate to the **Console → Signing Certificate** section.
|
||||
3. In the **Custom Signing Certificate** panel:
|
||||
- Click **Choose File** and upload your `.pfx` or `.p12` certificate file.
|
||||
- Enter your **certificate password** (required to unlock the private key).
|
||||
4. Click **Update** to save and activate your custom signing certificate.
|
||||
|
||||
> Once updated, all new documents signed using your OpenSign account will be digitally signed with your uploaded certificate.
|
||||
|
||||
---
|
||||
|
||||
## 🧾 Using the Default OpenSign Certificate
|
||||
|
||||
If you wish to revert to the standard OpenSign certificate:
|
||||
- Simply click **Use default OpenSign™ certificate**.
|
||||
- OpenSign will replace your custom certificate with its default one.
|
||||
<img width="861" height="408" alt="pfx_Certificate" src="https://github.com/user-attachments/assets/9063d927-c28f-4bb5-ac36-caeebc3845fc" />
|
||||
|
||||
---
|
||||
|
||||
## 🛡️ Security Notes
|
||||
|
||||
- OpenSign securely encrypts and stores your uploaded certificate.
|
||||
- Ensure that your PFX file and password are valid and belong to your organization.
|
||||
- Invalid or expired certificates may prevent successful document signing.
|
||||
- Use strong passwords for your certificate to maintain compliance and security.
|
||||
|
||||
---
|
||||
|
||||
## 💬 Need Help?
|
||||
|
||||
If you encounter any issues while uploading or activating your certificate, contact our support team at
|
||||
📩 **[support@opensignlabs.com](mailto:support@opensignlabs.com)**
|
||||
|
||||
**Empower your brand with trusted digital signatures — securely with OpenSign™.**
|
||||
Reference in New Issue
Block a user