Skip to content

Latest commit

 

History

History
37 lines (20 loc) · 1.8 KB

setup.md

File metadata and controls

37 lines (20 loc) · 1.8 KB

Getting Started

To get started using SatisPress, a few things need to be done:

  1. Add plugins or themes to the repository
  2. Create an API Key to access the repository
  3. Configure Composer to connect to the repository

Add Plugins or Themes to the Repository

When plugins and themes are added to the SatisPress repository the version that is currently installed is cached and saved as an artifact (zip file). New releases are also downloaded and saved as soon as WordPress is aware they're available.

All cached versions are exposed in packages.json so they can be required with Composer -- even versions that haven't yet been installed by WordPress!

When you first visit the Settings → SatisPress screen, click the Add Packages button to open the sidebar to select the plugins and themes you want to include in your repository.

Screenshot of the Repository tab showing how to add packages

Once packages have been added to the repository and releases become available, they can be downloaded directly from the Repository tab by clicking the button with the corresponding version number.

Screenshot of the Repository tab showing releases for a package

Create an API Key

Cached packages are automatically protected, so you'll need to create an API key on the Access tab to access them from Composer.

See the documentation on Security for more information.

Screenshot of the Access tab showing a list of API keys

Configure Composer

Finally, you need to add the SatisPress repository to composer.json and connect to it using an API key. The Composer tab contains instructions for configuring Composer.

See the documentation on Composer for more information.

Back to Index