Skip to content

Installation

This chapter describes the complete setup of anyPIM — from system requirements through the local development environment to production deployment on a Linux server.

Chapter Structure

Requirements

Detailed listing of all software and hardware requirements for anyPIM. Learn which PHP extensions must be installed, which MySQL version is supported, and the recommended server sizing.

Quick Start

Step-by-step guide to get anyPIM running locally in just a few minutes. Ideal for developers who want to be productive immediately. Covers cloning the repository, installing dependencies, configuring environment variables, and starting the development servers.

Deployment

Guide for production deployment on an Ubuntu server with Nginx, PHP-FPM, SSL certificates, Supervisor for the queue worker, and the automated deploy script. Also includes recommendations for monitoring, logging, and backup.

Technology Stack

ComponentTechnologyVersion
Backend FrameworkLaravel11.x
Programming LanguagePHP8.3+
Frontend FrameworkVue.js3.x
Build ToolVite6.x
CSS FrameworkTailwind CSS + DaisyUI4.x
DatabaseMySQL8.0+
Cache & QueueRedis6+
Web ServerNginx1.24+
Queue WorkerLaravel Horizon + Supervisor
AuthenticationLaravel Sanctum

License

anyPIM is released under the GPL-3.0-only license. This means:

  • You may freely use, modify, and distribute the software.
  • Modifications must be published under GPL-3.0 when distributed.
  • The full license can be found in the LICENSE file in the project directory.
  1. Check requirements — Ensure all required services are installed and properly configured.
  2. Follow Quick Start — Set up the system locally first and familiarize yourself with the configuration.
  3. Plan deployment — Transfer the configuration to your production server and set up automated deployment.

Note

If you only want to use the system for evaluation or development, the Quick Start is sufficient. The full Deployment is only required for production environments.

anyPIM Dokumentation