• ♡ Sponsor

    Installing Packages

    #Composer #Installation #Package

    Automad can be easily extended by installing custom packages. A package can be a theme or a PHP extension or a combination of both. The easiest way to install packages is to use the Packages section on the Automad dashboard. It also helps you to get an overview about available updates. However, since Automad uses Composer to manage all dependencies, you can also use the command line to install and update packages. Note that you can also take a look at all available packages on the package browser website.

    Composer

    Packages listed in Automad's Package Browser can also be installed and updated with Composer using the command line. Note that in case this sounds very complicated to you, you shouldn't be discouraged at all to try it out. Installing Composer as a package manager is just a matter of seconds and makes managing themes and extensions a lot easier. Packages can be installed using the require command:

    composer require <vendor/package>
    

    To keep your packages up to date, just use:

    composer update
    

    Related

    Getting Started

    Automad is a PHP application and therefore requires a web server to run. However, the list of system requirements is rather short. You can choose between three installation options: Composer, Docker or manual download. In case all this is new for you and you just want to get ...

    Getting Started  ⁄
    Local Installation — Getting Started

    You might want to install Automad first on your local Mac or Windows computer to get familiar with the system or start developing your site. Like any other CMS, Automad requires a webserver to be running. The easiest way to achive this, is to install a complete webserver package ...

    Getting Started  ⁄
    System Requirements — Getting Started

    Automad is primarily designed to be installed on shared hosting environments. Therefore Automad is tested on several Apache and Nginx web servers. Other environments are untested! The list of system requirements is rather short: Apache or Nginx webserver PHP 7.4+ including ...

    Getting Started  ⁄
    Terms of Use — Getting Started

    Automad is released under the MIT license and is free to use - for private websites as well as for commercial projects. Note that Automad takes the privacy of its users very serious and therefore only a very minimum of telemetry data is transmitted from time to time. At no point ...

    System  ⁄
    Updating Automad — System

    Keeping software up to date is always a good idea. Updating Automad takes only a couple of seconds. Initiating updates can be done via the dashboard or using the command line interface.

    Developer Guide  ⁄
    Building Themes — Developer Guide

    Themes are an essential part of a content management system. They define the way your content is presented to the visitors of your website. Automad's flexible and intuitive template language enables also inexperienced developers or beginners to create themes and templates on ...

    Developer Guide  ⁄
    Developing Extensions — Developer Guide

    The extension interface provides a convenient way of extending Automad's core functionality with custom PHP code while still offering Automad's template syntax. There are basically two types of template language extensions: generic extensions and custom pipe functions. Check out ...

    Developing Extensions  ⁄
    Generic Extensions — Developing Extensions

    In case you are missing any advanced feature while developing themes using Automad's template language, you are able to implement that functionality as a generic extension written in plain PHP.

    Developing Extensions  ⁄
    Custom Pipe Functions — Developing Extensions

    Automad provides already some basic string manipulation functions to be used with the pipe operator. However, in some cases it my be necessary to use a custom function to modify the content of a variable. Custom pipe functions can be written in plain PHP. Thier basic setup is ...

    Developer Guide  ⁄
    Publishing Packages — Developer Guide

    Automad uses Composer as dependency manager. Therefore packages can be made public by submitting them as Composer packages to the Packagist website. Published Automad packages also automatically appear in the package browser. The process of releasing a package is basically the ...

    Cheat Sheets  ⁄
    Creating Theme Packages — Cheat Sheets

    This guide describes step by step the workflow of setting up and publish a new theme. It assumes you're familiar with Visual Code Studio and working on a system with a Bash shell or similar — like macOS or Linux.

    Packages

    Browse free Composer packages and install themes and extensions for your Automad site.

    • Automad
    • System
    • Installing Packages
    Discuss
    Packages
    Release Notes
    Support
    Terms of Use
      Become a Sponsor
      GitHub
      Twitter
      Facebook
      Instagram
      2013-2023 by Marc Anton Dahmen
    Released under the MIT license

    A faceless machine, creating one's portrait in the internet.
  • Automad
  • Getting Started
  • System
  • User Guide
  • Developer Guide
  • Headless Mode
  • Discuss
  • Packages
  • Caching
  • Users
  • Updating Automad
  • RSS Feed
  • Language
  • Debugging
  • Installing Packages
  • Console
  • Allowed File Types
  • Securing the Dashboard
  • sitemap.xml