Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions docs/user-guide/administration/managing-memberships.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,12 @@ Free memberships are treated as **lifetime** memberships. They do not receive an

Click on a membership to access the page where you can edit the membership details — billing info, site or visit limits, and more.

![Membership edit interface](/img/admin/membership-edit.png)

Here's a full view of the membership edit page:

![Membership edit full interface](/img/admin/membership-edit-full.png)

You can also add new memberships associated with users previously registered on your network. Click **Add Membership** and configure the details.

![Add Membership modal](/img/admin/membership-add-modal.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,10 @@ Before you start receiving payments, you'll need to configure the payment-relate

![Payment settings tab](/img/admin/settings-payments-top.png)

Here's a full view of the payment settings page:

![Payment settings full page](/img/admin/settings-payments-full.png)

### General Payment Options

In the general settings you can configure:
Expand Down
4 changes: 4 additions & 0 deletions docs/user-guide/administration/managing-system-emails.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ From there, you can access the **System Emails** page to see all email templates

![System Emails list](/img/admin/system-emails-list.png)

You can also edit individual email templates using the system email editor:

![System email editor](/img/admin/system-email-editor.png)

## Importing New Email Templates

New Ultimate Multisite versions and add-ons may register new email templates. To prevent conflicts, new templates are not automatically added — you need to import them manually.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,10 @@ Navigate to **Ultimate Multisite > Settings > Memberships** and enable **Block F

![Block Frontend Access settings showing the toggle enabled, a grace period of 7 days, and a Frontend Block Page selection](/img/config/settings-membership-block-frontend.png)

Here's a full view of the membership settings page:

![Membership settings full page](/img/config/settings-membership-full.png)

Three related settings control this behavior:

| Setting | Description | Default |
Expand Down
32 changes: 32 additions & 0 deletions docs/user-guide/administration/touring-the-admin-panel.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,18 @@ The Ultimate Multisite **Dashboard** shows basic reports and analytics including

![Ultimate Multisite Dashboard](/img/admin/um-dashboard-top.png)

Here's a full view of the dashboard:

![Ultimate Multisite Dashboard full page](/img/admin/um-dashboard-full.png)

And the bottom section of the dashboard:

![Ultimate Multisite Dashboard bottom section](/img/admin/um-dashboard-bottom.png)

Here's also a full view of the network dashboard:

![Network Dashboard full page](/img/admin/network-dashboard-full-page.png)

## Checkout Forms

**Checkout Forms** give you the flexibility to create custom registration pages. You can customize fields, insert custom classes and scripts, and restrict access based on visitor country or location.
Expand Down Expand Up @@ -73,6 +85,26 @@ The **Settings** page is where you configure Ultimate Multisite — registration

![Settings page](/img/admin/settings-general.png)

Here's a full view of the general settings page:

![Settings general full page](/img/admin/settings-general-full.png)

And the emails settings page:

![Settings emails full page](/img/admin/settings-emails-full.png)

And the payments settings page:

![Settings payments full page](/img/admin/settings-payments-full.png)

And the bottom section of the payments settings:

![Settings payments bottom section](/img/admin/settings-payments-bottom.png)

And the sites settings page:

![Settings sites full page](/img/admin/settings-sites-full.png)

## Events

The **Events** page keeps a record of all events and logs in your network. It tracks activities like plan changes, signups, and other movements — useful for monitoring your multisite.
Expand Down
4 changes: 4 additions & 0 deletions docs/user-guide/client-management/account-page.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,6 +101,10 @@ This message can be edited (by you) on **Ultimate Multisite > Settings > Domain

![Add New Domain Instructions setting in Domain Mapping](/img/config/settings-domain-mapping.png)

Here's a full view of the domain mapping settings page:

![Domain mapping settings full page](/img/config/settings-domain-mapping-full.png)

After clicking **Next Step** , your customers can add their custom domain name and choose if this custom domain will be the primary one. Note that your customers can use more than one custom domain for their websites, so they can choose which one will be the primary one.

![Custom domain name entry with primary domain option](/img/admin/domains-list.png)
Expand Down
8 changes: 8 additions & 0 deletions docs/user-guide/client-management/client-websites.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,10 +17,18 @@ They can also see which one of their websites is the **primary** one for plans t

![My Sites page showing customer websites with Manage buttons](/img/admin/customers-list.png)

Here's a full view of the site edit interface:

![Site edit full interface](/img/admin/site-edit-full.png)

If they want to change their primary website, they need to go to the Account page by clicking on the **Account** menu.

![Account menu link in customer dashboard](/img/admin/customers-list.png)

You can also view and edit customer details:

![Customer edit interface](/img/admin/customer-edit.png)

Then, they should click on **Change Default Site**.

![Change Default Site button on account page](/img/admin/customers-list.png)
Expand Down
19 changes: 19 additions & 0 deletions docs/user-guide/configuration/checkout-forms.md
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,12 @@ Alternatively, you can edit or duplicate the forms you already have by clicking

![Checkout form hover actions](/img/config/checkout-form-hover-actions.png)

#### Checkout Form Editor Overview

The checkout form editor provides a comprehensive interface for building your registration forms. Here's an overview of the editor layout:

![Checkout Form editor overview](/img/config/checkout-form-editor-overview.png)

### Editing a Checkout Form

You can create checkout forms for different purposes. In this example we will work on a registration form.
Expand Down Expand Up @@ -92,6 +98,10 @@ You can also manually enable or disable your checkout form by toggling this opti

![Active toggle](/img/config/checkout-form-active.png)

To delete a form, click the delete option in the form actions:

![Checkout form delete option](/img/config/checkout-form-delete.png)

Don't forget to save your checkout form!

![Save button](/img/config/checkout-form-save.png)
Expand All @@ -106,8 +116,13 @@ The **Pricing Table** field displays your products on the checkout form so custo

![Pricing Table field settings](/img/config/pricing-table-field-settings.png)

Here's how the pricing table appears on the frontend registration form:

![Frontend checkout pricing table](/img/config/frontend-checkout-pricing-table.png)

* **Products**: Select which products to display and the order they appear in.
* **Force Different Durations**: When enabled, all products are shown regardless of whether they have a matching price variation for the currently selected billing period. When disabled (default), products without a variation for the selected period are hidden.
![Pricing table force durations option](/img/config/pricing-table-force-durations.png)
* **Hide when Pre-Selected**: Hides the pricing table when a plan has already been selected via the URL (e.g. `/register/premium`).
* **Pricing Table Template**: Choose the visual template for the pricing table (Simple List, Legacy, etc.).

Expand Down Expand Up @@ -142,6 +157,10 @@ Before adding the Period Selection field, make sure your products have price var

![Period Selection field settings](/img/config/period-selection-field-settings.png)

You can also configure the field options directly:

![Period selection field options](/img/config/period-selection-field-options.png)

6. Choose a **Period Selector Template** (Clean is the default, which renders a simple styled selector ready for custom CSS).

7. Click **Save Field**.
Expand Down
8 changes: 7 additions & 1 deletion docs/user-guide/configuration/creating-discount-codes.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,6 +35,10 @@ Lets take a look at the settings available here:

![Discount code name and description fields at the top of the edit page](/img/config/discount-code-description.png)

You can also view the discount code as active or inactive:

![Discount code active status](/img/config/discount-code-active.png)

**Coupon code:** Here is where you define the code your customers will need to enter during the checkout.

![Coupon code field where customers enter the code at checkout](/img/config/discount-code-coupon-field.png)
Expand All @@ -53,7 +57,9 @@ Lets take a look at the settings available here:

![Active toggle to manually enable or disable the discount code](/img/config/discount-code-active.png)

Under **Advanced Optio** **ns** , we have the following settings:
Under **Advanced Options**, we have the following settings:

![Discount code advanced options](/img/config/discount-code-advanced.png)

**Limit uses:**

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,8 @@ Price variations allow the network administrator to specify alternate pricing ti

To establish price variations, set the **Enable Price Variations** toggle to active and click the **Add new Price Variation** button.

![Product price variations](/img/config/product-price-variations.png)

To enter a variation, set the duration, period, and price of the variation. Additional variations can be entered by clicking the button again.

For example, if your base product price is $29.99 per month, you might add:
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,10 @@ Upon Ultimate Multisite installation, it automatically creates custom login and

![Login and Registration settings page](/img/config/settings-general.png)

Here's a full view of the login and registration settings page:

![Login and Registration settings full page](/img/config/settings-login-registration-full.png)

Let's take a look at each one of the options you can customize on the **Login & Registration** page:

* **Enable registration:** This option will enable or disable the registration on your network. If it is toggled off, your customers will not be able to register and subscribe to your products.
Expand Down
6 changes: 6 additions & 0 deletions docs/user-guide/configuration/site-templates.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,10 @@ This will open a modal window where it will ask for the **Site title, Site Domai

_![Add site template modal with site type dropdown](/img/config/site-templates-list.png)_

You can also view the site template description:

![Site template description](/img/config/site-template-description.png)

At the bottom of the form, you will notice a **Copy Site** toggle switch. This will allow you to create a new site template based on an existing site template as your starting point to help you save time instead of creating a site template from scratch.

![Add site template modal with copy site toggle](/img/config/site-templates-list.png)
Expand All @@ -35,6 +39,8 @@ At the bottom of the form, you will notice a **Copy Site** toggle switch. This w

To customize your site template, simply navigate to its dashboard panel and make the changes you need. You can create new posts, pages, activate plugins and change the active theme. You can even go to the Customizer and change all sorts of customization options.

![Site template edit interface](/img/config/site-template-edit.png)

All of that data will be copied over when a customer creates a new site based on that Site Template.

### Advanced Options
Expand Down
4 changes: 4 additions & 0 deletions docs/user-guide/configuration/the-registration-flow.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ After a user get to your registration page (usually clicking on a **Sign in** or

![Registration form displayed on the registration page](/img/config/checkout-forms-list.png)

Here's an example of the checkout form as it appears on the frontend:

![Frontend checkout registration form](/img/config/checkout-frontend-registration.png)

All they have to do is filling all the mandatory fields - email, username, password, etc... - and pay for the plan or confirm their email address if they are registering for a free plan or a paid plan with trial period without payment information.

On the "Thank you" page, they will see a message telling them if they need to confirm their email address or if their website is already activated and they can start using it.
Expand Down
5 changes: 5 additions & 0 deletions docs/user-guide/development/register-api-endpoint.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,11 @@ The endpoint uses the POST method and is called by the URL _**https://yoursite.c
For this process, you will need your API credentials. To get them, go to your network admin panel, navigate to **Ultimate Multisite > Settings** > **API & Webhooks,** and look for the API Settings section.

![API Settings section in Ultimate Multisite](/img/config/settings-api.png)

Here's a full view of the API settings page:

![API settings full page](/img/config/settings-api-full.png)

Select the **Enable API** and get your API credentials.

Now, let's explore the endpoint and then create a registration action in Zapier.
Expand Down
4 changes: 4 additions & 0 deletions docs/user-guide/integrations/webhooks.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ To create a webhook, go to your network admin dashboard. Click on **Ultimate Mul

![Webhooks list page with Add New Webhook button](/img/admin/webhooks-list.png)

You can then edit the webhook configuration:

![Webhook edit interface](/img/admin/webhook-edit.png)

When creating a new webhook you will be asked for information like **Name, URL,** and **Event**. You can use any name you want for your webhook. The most important fields are the URL and Event.

![New webhook form with Name, URL, and Event fields](/img/admin/webhooks-list.png)
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ To start an admin notice, go to your network admin dashboard and under the **Ult

![Broadcasts list page in Ultimate Multisite admin](/img/admin/broadcasts-list.png)

You can also edit existing broadcasts:

![Broadcast edit interface](/img/admin/broadcast-edit.png)

From this page, click the **Add Broadcast** button on top.

This will bring up the Add broadcast modal window where you can choose what type of broadcast you wish to send.
Expand Down
12 changes: 12 additions & 0 deletions docs/user-guide/payment-gateways/getting-paid.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,18 @@ You can setup the payment gateways on the same page ( **Ultimate Multisite > Set

We have a dedicated article for each payment gateway that will guide you through the steps of setting it up which you can find on the links below.

You can view and edit payment details:

![Payment edit interface](/img/admin/payment-edit.png)

Here's a full view of the payment edit page:

![Payment edit full interface](/img/admin/payment-edit-full.png)

Here's also a full view of the payment gateways settings:

![Payment gateways settings full page](/img/config/settings-payments-gateways-full.png)

**Setting up the Stripe gateway**

**Setting up the PayPal gateway**** **
Expand Down
4 changes: 4 additions & 0 deletions docs/user-guide/payment-gateways/manual-payments.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,10 @@ Add to this box the information your customer will need to make the payment. It

![Manual payment gateway toggle with Payment Instructions text area](/img/config/manual-gateway-expanded.png)

Here's the manual gateway settings interface:

![Manual gateway settings](/img/config/manual-gateway-settings.png)

After setting it up, just click on **Save Settings** and it is done. When users register to your network, they will see a message telling them that they will receive your instructions to complete the purchase.

![Registration confirmation message telling the user they will receive payment instructions](/img/frontend/registration-manual-notice.png)
Expand Down
8 changes: 8 additions & 0 deletions docs/user-guide/payment-gateways/tax-handling.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,14 @@ Tax collection is not enabled by default. To enable it, you need to go to **Ulti

![Enable Taxes toggle at the top of the Tax settings page](/img/config/settings-taxes-enable.png)

Here's a full view of the tax settings page:

![Tax settings full page](/img/config/settings-taxes-full.png)

You can also view the tax settings for individual products:

![Tax settings for products](/img/config/settings-taxes.png)

### Tax excluded vs. Tax included

By default, all your product prices are tax excluded, meaning that taxes **are not included** in the product's price. If we determine that a customer should pay taxes on a given purchase, we'll add the taxes **on top** of the subtotal.
Expand Down
Binary file removed static/img/admin/addons-list.png
Binary file not shown.
Binary file removed static/img/admin/system-info.png
Binary file not shown.
Binary file removed static/img/config/product-hide-credits.png
Binary file not shown.
Binary file removed static/img/config/settings-membership.png
Binary file not shown.
Binary file removed static/img/config/settings-whitelabel-full.png
Binary file not shown.
Binary file removed static/img/config/settings-whitelabel.png
Binary file not shown.
Binary file removed static/img/config/shortcodes-page.png
Binary file not shown.