Only this pageAll pages
Powered by GitBook
1 of 18

Help Center

Loading...

Getting started

Loading...

Loading...

Loading...

Plans and billing

Loading...

Loading...

Admin

Loading...

Loading...

Loading...

Integrations

Loading...

Loading...

Loading...

Community

Loading...

Getting started checklist

Everything you need to do to go from sign-up to a published site.

New here? Follow these steps to get up and running as quickly as possible.

1

Create your workspace

Your workspace is your home base. Give it your company or team name — you can change this later.

2

Invite your team

Head to Settings → Members and invite colleagues by email. Assign roles based on what they need to do: editors can create and edit content, reviewers can comment, and admins can manage settings.

3

Create your first project

Click New project from your workspace dashboard. Choose a template or start from scratch.

4

Add your content

Start writing pages, or import existing content from Markdown files, a URL, or a supported third-party platform.

5

Customise your site

Add your logo, set your brand colours, and configure your navigation under Settings → Appearance.

6

Publish

When you're ready, hit Publish. Your site will be live at your platform subdomain — or set up a custom domain to use your own.

Done all of the above? You're all set. Check out the rest of the help centre if you run into anything, or use the Ask button to chat with the assistant.

What's the difference between a workspace and a project?

Understand the difference between workspaces and projects, and when to use each.

A workspace is your top-level organisational container — think of it as your company or team's home. Everything lives inside a workspace: members, billing, settings, and all your projects.

A project is where your actual work happens. Each project has its own content, permissions, and settings, but it always belongs to a workspace.

Quick comparison

Workspace
Project

Contains

Members, projects, billing

Content, pages, files

Billing

Per workspace

Inherited from workspace

Permissions

Org-wide roles

Project-level roles

Limit

1 per account (Free)

Unlimited

When to create a new workspace vs. a new project

Create a new project when you're starting a distinct piece of work — a new product, a separate documentation site, or a team initiative. Projects are cheap and easy to manage.

Create a new workspace only when you need a completely separate billing and membership boundary — for example, an agency managing work for a different client, or a personal account kept separate from your employer.

Switching content between workspaces is not straightforward. If in doubt, start with a new project inside your existing workspace.

Related articles

  • Inviting team members to your workspace

  • Setting up a custom domain

Help Center

ELLIPAL never asks for your seed phrase. If someone claims to be support and asks, it's a scam.

How can we help you?

How do I update my ELLIPAL device firmware?

Find help by your product

Choose the product you're using

Find help by what you need to do

Browse common scenarios

Cover

Orders, Shipping & Payment

Cover

Setup my device

Cover

Send & Receive

Cover

Trade & Earn

Cover

Manage tokens & networks

Cover

Security

Cover

Update firmware

Cover

Lost device & Recovery

Cover

Warranty, Returns & Refunds

earth-europe
wallet
arrow-trend-up
bitcoin
shield
up-to-line
crutches
handshake

How do I change my plan?

Upgrade, downgrade, or switch between billing cycles at any time.

You can change your plan at any time from your workspace billing settings. Changes take effect immediately.

Upgrading your plan

1

Go to billing settings

Navigate to Settings → Billing → Plans.

2

Select a new plan

Click Upgrade on the plan you want to move to. You'll see a summary of the changes and any prorated charges.

3

Review the charges and click Confirm upgrade. Your new plan is active immediately.

When you upgrade mid-cycle, you're charged a prorated amount for the remainder of the current billing period. Your next full charge will be on your regular billing date.

Downgrades take effect at the end of your current billing period — you keep your current features until then.

You can switch to annual billing at any time to receive a discount. The switch takes effect at your next renewal date. Switching from annual back to monthly is possible but will take effect at the end of your annual term.

To cancel your subscription, go to Settings → Billing → Plans and click Cancel plan. Your workspace will revert to the Free plan at the end of your billing period. Your content is not deleted.

SSO configuration guide

Configure single sign-on so your team can log in with your existing identity provider.

Single sign-on (SSO) lets your team authenticate using your existing identity provider (IdP) rather than a separate password. SSO is available on Business and Enterprise plans.

Supported providers

We support any SAML 2.0-compatible identity provider, including most enterprise IdPs. Check your provider's documentation for instructions on creating a SAML application.

Setting up SSO

1

Create an application in your IdP

In your identity provider's admin console, create a new SAML application. You'll need the following values from our settings page:

  • ACS URL (also called the Reply URL or Callback URL)

  • Entity ID (also called the Audience URI)

These are available under Settings → Security → SSO.

2

From your identity provider, copy the Metadata URL or download the Metadata XML file.

3

Go to Settings → Security → SSO, paste your Metadata URL (or upload the XML file), and click Save.

4

Click Test SSO to verify the configuration before enabling it for your whole team. A test login window will open — complete the login and you'll see a success or error message.

5

Once the test passes, toggle Enforce SSO to on. All workspace members will now be required to log in via your IdP.

With SCIM provisioning enabled, users are automatically added to or removed from your workspace when you add or remove them in your IdP. SCIM setup is available under Settings → Security → SCIM.

Connecting a third-party app

Connect external tools to bring your content and workflows together.

Integrations let you pull content in from other platforms, push updates out, or automate parts of your workflow.

Available integrations

We currently support integrations with the following categories of tools:

  • Version control — connect your code repositories to sync and trigger workflows

  • Communication — post notifications and updates to your team's messaging tools

  • Support — link your helpdesk to surface relevant content for your support team

  • Analytics — track visitor behaviour on your published sites

  • SSO providers — authenticate your team via your existing identity provider

For a full list see Settings → Integrations → Browse.

1

Go to Settings → Integrations and click Browse all integrations.

2

Find the app you want to connect and click Install.

3

You can review, reconfigure, or disconnect integrations at any time from Settings → Integrations → Connected.

Integrations run with the permissions of the account used during authentication. We recommend using a service account or bot user where possible, to avoid disruption if an individual user leaves your organisation.

Inviting team members to your workspace

Add team members to your workspace and assign them the right roles.

You can invite as many team members as your plan allows from your workspace settings.

Sending invitations

1

Open member settings

Go to Settings → Members → Invite.

2

Enter email addresses

Type or paste one or more email addresses. You can invite multiple people at once by separating addresses with commas.

3

Select the role to assign to each invitee. See the roles section below for guidance on which to choose.

4

Click Send invitations. Each person will receive an email with a link to accept and join your workspace.

Invitations expire after 7 days. If someone hasn't accepted, you can resend from Settings → Members → Pending invitations.

Role
What they can do

Go to Settings → Members, find the person, and click Remove. Removing a member immediately revokes their access. Their content is not deleted.

Managing API keys

Manage API keys and monitor usage across your workspace.

API keys allow external tools and automations to interact with your workspace programmatically. Workspace admins can create, view, and revoke keys at any time.

Creating an API key

Go to Settings → API → Keys and click New API key. Give the key a descriptive name (e.g. "CI/CD integration" or "Internal dashboard") so you can identify it later.

Copy your key immediately after creation — it won't be shown again. If you lose it, you'll need to revoke and recreate it.

Key permissions

When creating a key, you can scope its permissions:

Permission
What it allows

Use the minimum permissions necessary for each integration.

To rotate a key, create a new one, update your integration to use it, then revoke the old key. There's no automated rotation — this is a manual process.

Go to Settings → API → Keys, find the key, and click Revoke. Revocation is immediate — any requests using that key will fail instantly.

Under Settings → API → Usage, you can see request counts per key over the past 30 days. This is useful for spotting unexpected usage or identifying which integrations are most active.

Billing FAQ

Answers to the most common billing questions.

When am I charged?

You're charged on the date you first subscribed, then on the same date each month or year depending on your billing cycle. You can see your next charge date under Settings → Billing → Overview.

What payment methods do you accept?

We accept all major credit and debit cards and bank transfers for annual Enterprise plans. We don't currently accept PayPal.

Can I get a refund?

We offer a full refund within 14 days of your initial purchase or renewal if you haven't made significant use of the platform during that period. Prorated refunds for unused time are not available outside this window. to request a refund.

How do I get an invoice?

Invoices are emailed automatically after each charge. You can also download past invoices from Settings → Billing → Invoices. To add a billing address, VAT number, or purchase order number to your invoices, go to Settings → Billing → Billing details.

Do you support VAT exemption?

Yes. If your organisation is VAT-exempt, add your VAT number under Settings → Billing → Billing details and it will be applied to future invoices. We cannot retroactively adjust past invoices.

What happens if my payment fails?

If a payment fails, we'll retry it over the following 7 days and send you an email notification. If payment is not resolved within that period, your workspace will be downgraded to the Free plan. Your content is not deleted.

Can I have separate billing for different workspaces?

Yes — each workspace has its own billing. If you manage multiple workspaces, each one can be on a different plan and billed separately.

API rate limits and quotas

Understand the API rate limits that apply to your plan, and what to do if you hit them.

Rate limits protect platform stability and ensure fair usage across all customers. If you're building an integration or automation on top of our API, it's worth understanding how they work.

Plan
Requests per minute
Requests per day

Contributing to the platform

Help improve the platform by contributing feedback, bug reports, and ideas.

We build this platform with our community. There are a few ways you can contribute and help shape what we build next.

Found something that's not working as expected? We want to know.

When reporting a bug, please include:

  • A clear description of what happened vs. what you expected

  • Steps to reproduce the issue

Why isn't my integration syncing?

Common reasons your integration stops syncing, and how to fix them.

If content from a connected app isn't appearing or updating as expected, work through the checks below.

Go to Settings → Integrations and find the affected integration. If the status shows Disconnected or Error, click Reconnect and follow the prompts to re-authenticate.

The account used to connect the integration needs sufficient permissions in the third-party app. For example, connecting a content source requires at least read access to the relevant data.

Some third-party platforms impose rate limits on API access. If you're syncing large amounts of content or triggering many syncs in quick succession, you may be temporarily throttled. Wait a few minutes and try again.

On the integration settings page, click Sync now to force an immediate sync rather than waiting for the next scheduled run.

Confirm payment

Downgrading your plan

Before downgrading, check that your usage is within the limits of your new plan. If you have more members, projects, or content than the lower plan allows, you'll need to reduce usage before the downgrade takes effect.

Switching between monthly and annual billing

Cancelling

Copy your IdP metadata

Configure SSO in your workspace

Test the connection

Enable SSO

Make sure you can log in via SSO before enabling enforcement. If SSO breaks after enforcement is on, contact support — we can disable it for you from the backend.

Provisioning and deprovisioning

You'll be redirected to the third-party app to grant access. Make sure you're logged in to the correct account before approving.
4

Configure

Once connected, you'll be returned to your settings where you can configure sync frequency, which content to include, and any app-specific options.

Connecting an integration

Open the integrations page

Choose an integration

Authenticate

Managing connected integrations

Disconnecting an integration does not delete any content that was already synced — it just stops future syncs.

Permissions and access

Read

Fetch content, settings, and member data

Write

Create and update content

Admin

Manage settings, members, and billing

Rotating a key

Revoking a key

Monitoring usage

Contact support

Read published and draft content

Guest

Read published content only (does not use a seat)

Admin

Manage settings, billing, members, and all content

Editor

Create, edit, and publish content

Reviewer

Comment on content, but not edit or publish

Choose a role

Send the invite

Roles

Guests are useful for external stakeholders who need to read drafts without being full members. They don't count towards your member limit.

Removing members

Viewer

Your browser, operating system, and plan

  • Screenshots or a screen recording if relevant

  • You can report bugs via the community forum or directly through support.

    We track feature requests in the community forum under the Ideas category. Before submitting, search to see if your idea already exists — if it does, upvote it rather than creating a duplicate.

    A good feature request explains:

    • The problem you're trying to solve

    • How you're currently working around it (if at all)

    • Why you think it would be useful to others

    We review and respond to ideas regularly, and use upvotes to help prioritise our roadmap.

    If you've written a blog post, tutorial, or made a video about the platform, we'd love to see it. Share it in the Showcase category on the forum — popular community content gets featured in our newsletter and social channels.

    From time to time we invite users to participate in user research sessions — interviews, usability tests, and surveys. If you'd like to be considered, opt in under Settings → Account → Research participation.

    Reporting bugs

    Suggesting features

    Writing about us

    Participating in research

    Under Settings → Integrations → [Integration name] → Logs, you'll find a record of recent sync attempts and any errors. Error messages here are usually specific enough to identify the problem.

    If none of the above resolves the issue, contact support with your sync log attached — this helps us diagnose the problem quickly.

    1. Check the connection status

    2. Check your permissions

    If the account that originally connected the integration has left your organisation or had their permissions changed, the integration will stop working. Reconnect using an account with the correct permissions.

    3. Check for rate limits

    4. Trigger a manual sync

    5. Review the sync log

    Still not working?

    Pro

    300

    10,000

    Business

    1,000

    100,000

    Enterprise

    Custom

    Custom

    Every API response includes headers showing your current usage:

    X-RateLimit-Reset is a Unix timestamp indicating when your limit resets.

    Requests that exceed the rate limit receive a 429 Too Many Requests response. Your client should back off and retry after the time indicated in the Retry-After header.

    If your use case requires higher limits, upgrading your plan is the first step. For Enterprise-level requirements, contact us to discuss custom quotas.

    Free

    60

    1,000

    Limits by plan

    Rate limit headers

    What happens when you hit the limit

    Repeatedly hammering the API after receiving a 429 may result in a temporary ban on your API key. Always implement exponential backoff in your integration.

    Increasing your limits

    X-RateLimit-Limit: 300
    X-RateLimit-Remaining: 241
    X-RateLimit-Reset: 1714560000
    X Card
    Titan 2.0
    Cover

    Tap-to-sign card. Fits in your wallet, signs by NFC.

    Cover

    Air-gapped vault with 4-inch screen. Built forlong-term holding.

    X Card

    Titan 2.0 (Titan series)

    Payment Methods
    Status of my order
    Shipping Methods & Costs
    How do I transfer assets from an exchange to my ELLIPAL wallet?
    How do I swap crypto in the ELLIPAL App?
    How do I buy crypto with fiat currency?
    Read more →
    Common Sending Issues and Solutions
    Common Receiving Issues and Solutions
    Buy
    Swap
    Predict
    Token & Network Basics
    How to Add Networks to Your ELLIPAL?
    How to Add or Remove Tokens?
    What are Seed Phrase, Passphrase, Password, and Card-PIN?
    Verify the Seed Phrase
    Common Crypto Scams
    Firmware Upgrade Guide (Titan Series)
    How to Download the Firmware Update File to a microSD Card on Your Phone?
    What should I do if my ELLIPAL device is lost or stolen?
    How do I factory reset my ELLIPAL Titan?
    How do warranty and returns work?

    Setting up a custom domain

    Point your own domain or subdomain at your published site.

    By default your site is published at a subdomain of our platform. You can replace this with your own domain (e.g. docs.yourcompany.com) on any paid plan.

    Prerequisites

    • A paid plan (Pro or above)

    • Access to your domain's DNS settings

    • A published site

    1

    Go to Settings → Publishing → Custom domain and enter the domain or subdomain you want to use (e.g. docs.yourcompany.com). Click Save.

    2

    In your DNS provider, create a CNAME record pointing your subdomain to the address shown in your settings. Changes can take up to 48 hours to propagate, though usually it's much faster.

    3

    Verification keeps failing Make sure there are no conflicting DNS records for the same subdomain. An existing A record will block the CNAME.

    SSL certificate not provisioning SSL is issued automatically after DNS verification. If it hasn't appeared after 30 minutes, try clicking Verify again.

    Site loads but shows an SSL warning This usually means a cached or old certificate. Try clearing your browser cache, or wait a few more minutes for propagation to complete.

    Verify and activate

    Return to Settings → Publishing → Custom domain and click Verify. Once verified, SSL is provisioned automatically — this usually takes a few minutes.

    Steps

    Add your domain in settings

    Create a CNAME record

    Using an apex domain (e.g. yourcompany.com without a subdomain)? You'll need to set an ALIAS or ANAME record instead of a CNAME. Not all DNS providers support this — check your provider's documentation.

    Troubleshooting

    Type:  CNAME
    Name:  docs
    Value: sites.example-platform.com