GitHub PHP Daily Trending Repositories

cachethq/cachet

🚦 Cachet, the open source, self-hosted status page system.

Cachet, the open source self-hosted status page system.

Cachet 3.x Announcement

For more information on the Cachet rebuild and our plans for 3.x, you can read the announcement here.

Requirements

PHP 8.3 or later
Composer
A supported database: MariaDB, MySQL, PostgreSQL or SQLite

Installation, Upgrades and Documentation

You can find documentation at https://docs.cachethq.io.

Here are some useful quick links:

Installing Cachet

Demo

To test out the v3 demo, you can log in to the Cachet dashboard with the following credentials:

Email: test@test.com
Password: test123

Note The demo automatically resets every 30 minutes.

Sponsors

Security Vulnerabilities

If you discover a security vulnerability within Cachet, please send an e-mail to support@cachethq.io. All security vulnerabilities are reviewed on a case-by-case basis.

PHP-CS-Fixer/PHP-CS-Fixer

A tool to automatically fix PHP Coding Standards issues

PHP Coding Standards Fixer

The PHP Coding Standards Fixer (PHP CS Fixer) fixes your code to follow the standards.

If you are already using a linter to identify coding standards problems in your code, you know that fixing them by hand is tedious, especially on large projects. This tool not only detects them, but also fixes them for you.

PHP CS Fixer has built-in rule sets, whether you want to follow PHP coding standards as defined by PHP-FIG's PER Coding Style - @PER-CS, a wide community like the Symfony - @Symfony, or our opinionated one - @PhpCsFixer. You can also define your (team's) style through the configuration file.

PHP CS Fixer can not only unify the style of your code, but also help to modernise your codebase towards newer PHP (e.g. @autoPHPMigration and @autoPHPMigration:risky) and newer PHPUnit (e.g. @autoPHPUnitMigration:risky).

There are also @auto and @auto:risky that aim to provide good base rules.

Supported PHP Versions

PHP 7.4 - PHP 8.5

Note

Each new PHP version requires a huge effort to support the new syntax. That's why the latest PHP version might not be supported yet. If you need it, please consider supporting the project in any convenient way, for example, with code contributions or reviewing existing PRs. To run PHP CS Fixer on yet unsupported versions "at your own risk" - use --allow-unsupported-php-version=yes option.

Documentation

Installation

The recommended way to install PHP CS Fixer is to use Composer:

composer require --dev friendsofphp/php-cs-fixer
## or when facing conflicts in dependencies:
composer require --dev php-cs-fixer/shim

For more details and other installation methods (also with Docker or behind CI), see installation instructions.

Usage

Assuming you installed PHP CS Fixer as instructed above, you can initialise base config for your project by using following command:

./vendor/bin/php-cs-fixer init

To automatically fix your project, or only check against the need of changes, run:

./vendor/bin/php-cs-fixer fix
./vendor/bin/php-cs-fixer check

See usage, list of built-in rules, list of rule sets and configuration file documentation for more details.

If you need to apply code styles that are not built-in into the tool, you can create custom rules.

Editor Integration

Native support exists for:

PhpStorm

Community plugins exist for:

Community

The PHP CS Fixer is maintained on GitHub at https://github.com/PHP-CS-Fixer/PHP-CS-Fixer. Contributions, bug reports and ideas about new features are welcome there.

You can reach us in the GitHub Discussions regarding the project, configuration, possible improvements, ideas and questions.

Contribute

The tool comes with quite a few built-in fixers, but everyone is more than welcome to contribute more of them.

danielmiessler/SecLists

About SecLists

SecLists is the security tester's companion. It's a collection of multiple types of lists used during security assessments, collected in one place. List types include usernames, passwords, URLs, sensitive data patterns, fuzzing payloads, web shells, and many more. The goal is to enable a security tester to pull this repository onto a new testing box and have access to every type of list that may be needed.

This project is maintained by Daniel Miessler, Jason Haddix, Ignacio Portal and g0tmi1k.

Repository details

Install

Zip

wget -c https://github.com/danielmiessler/SecLists/archive/master.zip -O SecList.zip && unzip SecList.zip && rm -f SecList.zip

Git: No commit history (faster)

git clone --depth 1 https://github.com/danielmiessler/SecLists.git

Git: Complete

git clone https://github.com/danielmiessler/SecLists.git

Kali Linux (Tool Page)

apt -y install seclists

BlackArch (Tool Page)

sudo pacman -S seclists

Attribution

See CONTRIBUTORS.md

Contributing

See CONTRIBUTING.md

Similar Projects

Assetnote Wordlists: High quality wordlists for content and subdomain discovery which are automatically updated every month.
fuzz.txt: Wordlists of "potentially dangerous" files.
FuzzDB: Dictionary of attack patterns and primitives for black-box application fault injection and resource discovery.
PayloadsAllTheThings: A list of useful payloads and bypass for Web Application Security and Pentest/CTF
BiblePass: Wordlists compiled from Bible verses
SamLists: Data-driven wordlists containing HTTP parameter names, directory names and filenames.

Wordlist Tools

Cook: A wordlist framework. An overpowered wordlist generator, splitter, merger, finder and saver. Cook facilitates the creation of permutations and combinations with a variety of encodings and many more features.
Wl: CLI utility for converting strings to a given casing style.
CeWL: Custom Word List generator.
Genoveva: From a word list, it generates up to 17,335,754 combinations per word, mixing lowercase, capitalized, uppercase, full and partial L33T (for each vowel and "s"), reverse, numbers from 1 to 4 digits, dates in mmddyyyy format from 1950 to 2030, date format mmddyy, symbols at the end, symbols between name and date...

Also checkout the .bin directory in this repository. We have a number of wordlist generators and mutators there.

💜 Support This Project

We spend hundreds of hours a year on open source. If you'd like to help support this project, you can sponsor us here:
danielmiessler (founder)
ItsIgnacioPortal (current maintainer since 2021)

Licensing

This project is licensed under the MIT license.

^{NOTE: Downloading this repository is likely to cause a false-positive alarm by your anti-virus or anti-malware software, the filepath should be whitelisted. There is nothing in SecLists that can harm your computer as-is, however it's not recommended to store these files on a server or other important system due to the risk of local file include attacks.}

nextcloud/all-in-one

📦 The official Nextcloud installation method. Provides easy deployment and maintenance with most features included in this one Nextcloud instance.

Nextcloud All-in-One

Note

Nextcloud AIO is actively looking for contributors. See the forum post.

The official Nextcloud installation method. Nextcloud AIO provides easy deployment and maintenance with most features included in this one Nextcloud instance.

Included are:

Nextcloud
High performance backend for Nextcloud Files (Client Push)
Redis & APCU for performant caching
PostgreSQL as database
Nextcloud Office (optional)
EuroOffice (optional)
High performance backend for Nextcloud Talk and TURN-server (optional)
Nextcloud Talk Recording-server (optional)
Backup solution (optional, based on BorgBackup)
Imaginary (optional, for previews of heic, heif, illustrator, pdf, svg, tiff and webp)
ClamAV (optional, Antivirus backend for Nextcloud)
Fulltextsearch (optional)
Whiteboard (optional)
Docker Socket Proxy (optional, needed for Nextcloud App API)
Community containers

And much more:

Simple web interface included that enables easy installation and maintenance
Easy updates included
Update and backup notifications included
Daily backups can be enabled from the AIO interface which also allows updating all containers, Nextcloud and its apps afterwards automatically
Instance restore from backup archive via the AIO interface included (you only need the archive and the password in order to restore the whole instance on a new AIO instance)
APCu as local cache
Redis as distributed cache and for file locking
Postgresql as database
PHP-FPM with performance-optimized config (e.g. Opcache and JIT enabled by default)
A+ security in Nextcloud security scan
Ready to be used behind existing Reverse proxies
Can be used behind Cloudflare Tunnel
Can be used via Tailscale
Ready for big file uploads up to 10 GB on public links, adjustable (logged in users can upload much bigger files using the webinterface or the mobile/desktop clients since chunking is used in that case)
PHP and web server timeouts set to 3600s, adjustable (important for big file uploads)
Defaults to a max of 512 MB RAM per PHP process, adjustable
Automatic TLS included (by using Let's Encrypt)
zstd/gzip compression enabled by default inside caddy inside the apache container
HTTP/2 and HTTP/3 enabled
"Pretty URLs" for Nextcloud are enabled by default (removes the index.php from all links)
Video previews work out of the box and when Imaginary is enabled, many recent image formats as well!
Only one domain and not multiple domains are required for everything to work (usually you would need to have one domain for each service which is much more complex)
Adjustable location of Nextcloud's datadir (e.g. good for easy file-sharing with host system on Windows and MacOS)
By default confined (good for security) but can allow access to additional storages in order to enable the usage of the local external storage feature
Possibility included to adjust default installed Nextcloud apps
Nextcloud installation is not read only - that means you can apply patches if you should need them (instead of having to wait for the next release for them getting applied)
ffmpeg, smbclient and nodejs are included by default
Possibility included to permanently add additional OS packages into the Nextcloud container without having to build your own Docker image
Possibility included to permanently add additional PHP extensions into the Nextcloud container without having to build your own Docker image
Possibility included to pass the needed device for hardware transcoding to the Nextcloud container
Possibility included to store all docker related files on a separate drive
LDAP can be used as user backend for Nextcloud
Migration from any former Nextcloud installation to AIO is possible. See this documentation.
Migration in the other direction (e.g. from AIO to a VM-based installation) is also possible.
Fail2Ban can be added
phpMyAdmin, Adminer or pgAdmin can be added
Mail server can be added
Nextcloud can be accessed locally via the domain
Can be installed locally (if you don't want or cannot make the instance publicly reachable)
Free deSEC dynamic-DNS domain (*.dedyn.io) can be registered directly from the AIO interface — no external domain needed
IPv6-ready
Can be used with Docker rootless (good for additional security)
Runs on all platforms Docker supports (e.g. also on Windows and Macos)
Included containers easy to debug by having the possibility to check their logs directly from the AIO interface
Docker-compose ready
Can be installed without a container having access to the docker socket
Can be installed with Docker Swarm
Can be installed with Kubernetes
Almost all included containers Alpine Linux based (good for security and size)
Many of the included containers run as non-root user (good for security)
Many of the included containers have a read-only root-FS (good for security)
Included containers run in its own docker network (good for security) and only really necessary ports are exposed on the host
Multiple instances on one server are doable without having to deal with VMs
Adjustable backup path or remote borg repository from the AIO interface (good to put the backups e.g. on a different drive if using a local backup path)
Possibility included to also back up external Docker Volumes or Host paths (can be used for host backups)
Borg backup can be completely managed from the AIO interface, including backup creation, backup restore, backup integrity check and integrity-repair
Other forms of remote backup are indirectly possible
Updates and backups can be run from an external script. See this documentation for a complete example.

Screenshots

First setup	After installation

Architecture overview

flowchart TB
    %% ── Styles ───────────────────────────────────────────────────────────────────
    classDef user      fill:#FFF3CD,stroke:#F0AD4E,color:#333
    classDef master    fill:#E8D5F5,stroke:#9B59B6,color:#222
    classDef core      fill:#D6EAF8,stroke:#2E86C1,color:#222
    classDef opt       fill:#D5F5E3,stroke:#27AE60,color:#222
    classDef community fill:#FDEBD0,stroke:#E67E22,color:#222
    classDef access    fill:#EAFAF1,stroke:#1E8449,color:#222

    %% ── Top row: people ─────────────────────────────────────────────────────────
    YOU(["🧑‍💻 Admin\n(You)"]):::user
    ENDUSER(["🧑‍🤝‍🧑 Users\n(family / team)"]):::user

    %% ── Everything that runs inside AIO ─────────────────────────────────────────
    subgraph AIO["  🐳  Nextcloud AIO  "]
        MC(["🧠 Mastercontainer\n─────────────────────────\n▸ AIO interface :8080 / :8443\n▸ Manages & updates containers\n▸ Handles backups"]):::master

        subgraph CORE["  📦  Core Stack  (auto-started)  "]
            PROXY(["🔀 Apache\nProxy & HTTPS"]):::core
            NC(["☁️ Nextcloud\nApp Server"]):::core
            DB(["🗄️ PostgreSQL\nDatabase"]):::core
            CACHE(["⚡ Redis\nCache"]):::core
            PUSH(["🔔 Notify Push\nReal-time sync"]):::core
        end

        subgraph OPT["  🧩  Optional Built-in Containers  (enable in AIO interface)  "]
            COLLA(["📄 Nextcloud Office"]):::opt
            EO(["📄 EuroOffice\nDocument Server"]):::opt
            TALK(["🎙️ Talk\nVideo & Voice calls"]):::opt
            TALKREC(["🎬 Talk Recording"]):::opt
            FTS(["🔎 Full-text Search\n(Elasticsearch)"]):::opt
            IMAG(["🖼️ Imaginary\nImage previews"]):::opt
            CLAM(["🦠 ClamAV\nAntivirus"]):::opt
            WB(["🖊️ Whiteboard"]):::opt
        end

        COMM(["🌍 Community Containers\n──────────────────────\n30+ optional add-ons\nSee community-containers/"]):::community
        click COMM "https://github.com/nextcloud/all-in-one/tree/main/community-containers#community-containers" "Browse community containers"
    end

    %% ── Result node (outside AIO) ────────────────────────────────────────────────
    NC_URL(["🌐 https://your-domain.com\n✅ Nextcloud — ready to use!"]):::access

    %% ── Flows ────────────────────────────────────────────────────────────────────
    YOU -->|"① open :8080 or :8443 in browser"| MC
    MC -->|"② auto-starts & wires up"| CORE
    MC -. "③ enable in AIO interface" .-> OPT
    MC -. "④ add via AIO interface" .-> COMM

    PROXY --> NC
    NC --- DB
    NC --- CACHE
    NC --- PUSH
    OPT -->|"integrate with"| NC
    COMM -.->|"integrate with"| NC

    CORE -->|"⑤ stack is ready!"| NC_URL
    ENDUSER -->|"⑥ browser / app"| NC_URL
    YOU -->|"⑥ use normally"| NC_URL

How to use this?

The steps below are written for Linux. For platform-specific guidance see:

macOS: How to run AIO on macOS?
Windows: How to run AIO on Windows?
Unraid: How to run AIO on Unraid?
Synology DSM: How to run AIO on Synology DSM?
TrueNAS SCALE: Can I run AIO on TrueNAS SCALE?

Important

These instructions assume there is no existing web server or reverse proxy (for example Apache, Nginx, Caddy, or Cloudflare Tunnel) that you intend to place in front of AIO. If you plan to run AIO behind an existing web server or reverse proxy, follow the AIO reverse proxy documentation: Reverse proxy docs

You're encouraged to skim the attached FAQ. While we've tried to make things straightforward, Nextcloud is a large and flexible platform. Reading the FAQ will save you time, particularly if edge cases come up.

Tip

Don't worry about getting everything perfect on the first try — test deployments are cheap and disposable.

Install Docker on your Linux host by following the official documentation: Docker install — supported platforms

Warning

Snap-based Docker installations are not supported. Make sure you are not using a snap-based Docker installation (generally only applicable to Ubuntu). To check, run:

sudo docker info | grep "Docker Root Dir" | grep "/var/snap/docker/"

If you see the following output:

/var/snap/docker/

you should migrate to a standard Docker installation and remove the snap-based package before proceeding: Install Docker on Ubuntu.

⚠️ To avoid losing data or interrupting services, only remove the Docker snap after you are certain you're not running any existing containers in it.

Consult the official Docker documentation or other guides for instructions on migrating existing containers. Once you are certain it's safe, remove the snap-based Docker installation with:

sudo snap remove docker

If you need IPv6 support, enable it by following: Docker IPv6 support for AIO
AIO uses a special mastercontainer to orchestrate the various pieces of the Nextcloud stack. To start AIO, launch the mastercontainer with the command below:

# For Linux and without a web server or reverse proxy already in place:
sudo docker run \
  --init \
  --sig-proxy=false \
  --name nextcloud-aio-mastercontainer \
  --restart always \
  --publish 80:80 \
  --publish 8080:8080 \
  --publish 8443:8443 \
  --volume nextcloud_aio_mastercontainer:/mnt/docker-aio-config \
  --volume /var/run/docker.sock:/var/run/docker.sock:ro \
  ghcr.io/nextcloud-releases/all-in-one:latest

Explanation of the command

sudo docker run — starts a new Docker container. Omit sudo if your user is in the docker group.
--init — runs an init process inside the container to handle zombie processes.
--sig-proxy=false — prevents Ctrl+C in the attached terminal from stopping the container.
--name nextcloud-aio-mastercontainer — the container name. Do not change this name; mastercontainer updates rely on it.
--restart always — ensures the container restarts automatically with the Docker daemon.
--publish 80:80 — publishes container port 80 on host port 80 (used for ACME http-challenge when obtaining certificates, used for for the AIO-interface running inside the mastercontainer). Not required if you run AIO behind a reverse proxy.
--publish 8080:8080 — publishes the AIO interface (self-signed certificate) on host port 8080. You may map a different host port if 8080 is in use (e.g. --publish 8081:8080).
--publish 8443:8443 — publishes the AIO interface with a valid certificate on host port 8443 (requires ports 80 and 8443 to be reachable and a domain pointing to your server). Not required if you run AIO behind a reverse proxy.
--volume nextcloud_aio_mastercontainer:/mnt/docker-aio-config — stores mastercontainer configuration in the named Docker volume. Do not change this volume name; built-in backups depend on it.
--volume /var/run/docker.sock:/var/run/docker.sock:ro — mounts the Docker socket (read-only) so the mastercontainer can manage other containers. On Windows/macOS or when using rootless Docker, this path may need adjustment; see the platform-specific docs. If you change the socket path, also set WATCHTOWER_DOCKER_SOCKET_PATH accordingly. If you prefer not to expose the socket, see the manual-install documentation: Manual install without docker socket access
ghcr.io/nextcloud-releases/all-in-one:latest — the mastercontainer image.

Additional options can be set with environment variables (for example --env NEXTCLOUD_DATADIR="/mnt/ncdata" to change Nextcloud's datadir on first startup). See the Customization section and example compose file: compose.yaml for more options.

Tip

If you want Nextcloud’s data directory in a different location than the default Docker volume, see "How to change the default location of Nextcloud's Datadir" in this README: How to change the default location of Nextcloud's Datadir

Note

For production usage (and ease of upgrades and changes), we suggest using the example Compose file rather than docker run.

After the initial startup, open the Nextcloud AIO interface on port 8080 of this server by IP address, for example:

https://192.168.5.5:8080

Caution

Use an IP address (not a domain) when accessing the AIO interface on port 8080. Accessing via a domain may work temporarily but is likely to break later due to HSTS.

Port 8080 uses a self-signed certificate that you must accept in your browser.

It is also possible to obtain a valid certificate automatically if your firewall/router forwards ports 80 and 8443 and you point a domain to your server. In that case, access the AIO interface using the dedicated port for this purpose (8443), for example:

https://your-domain-that-points-to-this-server.tld:8443

If you enable Nextcloud Talk, open port 3478/TCP and 3478/UDP in your firewall/router for the Talk (TURN) container.

Tip

Don't have a domain yet? AIO can register a free dynamic-DNS subdomain under dedyn.io for you via deSEC — no external setup needed. Look for the "Don't have a domain? Get a free one from deSEC" section on the AIO interface when you are asked to enter your domain. AIO will automatically register the domain, keep the DNS record up to date, and enable the Caddy community container as a reverse proxy as well as the dnsmasq container for local DNS resolution.

FAQ

Where can I find additional documentation?

Some of the documentation is available on GitHub Discussions.

How does it work?

Nextcloud AIO is inspired by projects like Portainer that manage the docker daemon by talking to it through the docker socket directly. This concept allows a user to install only one container with a single command that does the heavy lifting of creating and managing all containers that are needed in order to provide a Nextcloud installation with most features included. It also makes updating a breeze and is not bound to the host system (and its slow updates) anymore as everything is in containers. Additionally, it is very easy to handle from a user perspective because a simple interface for managing your Nextcloud AIO installation is provided.

How to contribute?

See this issue for a list of feature requests that need help by contributors.

How many users are possible?

Up to 100 users are free, more are possible with Nextcloud Enterprise

Network

Are reverse proxies supported?

Yes. Please refer to the following documentation on this: reverse-proxy.md

Which ports are mandatory to be open in your firewall/router?

Only those (if you access the Mastercontainer Interface internally via port 8080):

443/TCP for the Apache container
443/UDP if you want to enable http3 for the Apache container
3478/TCP and 3478/UDP for the Talk container

Explanation of used ports

8080/TCP: Mastercontainer Interface with self-signed certificate (works always, also if only access via IP-address is possible, e.g. https://ip.address.of.this.server:8080/) ⚠️ Important: do always use an ip-address if you access this port and not a domain as HSTS might block access to it later! (It is also expected that this port uses a self-signed certificate due to security concerns which you need to accept in your browser)
80/TCP: redirects to Nextcloud (is used for getting the certificate via ACME http-challenge for the Mastercontainer)
8443/TCP: Mastercontainer Interface with valid certificate (only works if port 80 and 8443 are open/forwarded in your firewall/router and you point a domain to your server. It generates a valid certificate then automatically and access via e.g. https://public.domain.com:8443/ is possible.)
443/TCP: will be used by the Apache container later on and needs to be open/forwarded in your firewall/router
443/UDP: will be used by the Apache container later on and needs to be open/forwarded in your firewall/router if you want to enable http3
3478/TCP and 3478/UDP: will be used by the Turnserver inside the Talk container and needs to be open/forwarded in your firewall/router

Notes on Cloudflare (proxy/tunnel)

Since Cloudflare Proxy/Tunnel comes with a lot of limitations which are listed below, it is rather recommended to use the built-in deSEC domain registration or switch to Tailscale if possible.

Cloudflare Proxy and Cloudflare Tunnel both require Cloudflare to perform TLS termination on their side and thus decrypt all the traffic on their infrastructure. This is a privacy concern and you will need to look for other solutions if it's unacceptable for you.
Using Cloudflare Tunnel might potentially slow down Nextcloud since local access via the configured domain is not possible because TLS termination is in that case offloaded to Cloudflare's infrastructure. There is no way to disable this behavior in Cloudflare Tunnel.
It is known that the domain validation may not work correctly behind Cloudflare since Cloudflare might block the validation attempt. You can simply skip it in that case by following: https://github.com/nextcloud/all-in-one#how-to-skip-the-domain-validation
Make sure to disable Cloudflares Rocket Loader feature as otherwise Nextcloud's login prompt will not be shown.
Cloudflare only supports uploading files up to 100 MB in the free plan, if you try to upload bigger files you will get an error (413 - Payload Too Large) if no chunking is used (e.g. for public uploads in the web, or if chunks are configured to be bigger than 100 MB in the clients or the web). If you need to upload bigger files, you need to disable the proxy option in your DNS settings. Note that this will both disable Cloudflare DDoS protection and Cloudflare Tunnel as these services require the proxy option to be enabled.
If using Cloudflare Tunnel and the Nextcloud Desktop Client Set Chunking on Nextcloud Desktop Client
Cloudflare only allows a max timeout of 100s for requests which is not configurable. This means that any server-side processing e.g. for assembling chunks for big files during upload that take longer than 100s will simply not work. See https://github.com/nextcloud/server/issues/19223. If you need to upload big files reliably, you need to disable the proxy option in your DNS settings. Note that this will both disable Cloudflare DDoS protection and Cloudflare Tunnel as these services require the proxy option to be enabled.
It is known that the in AIO included collabora (Nextcloud Office) does not work out of the box behind Cloudflare. To make it work, you need to add all Cloudflare IP-ranges to the wopi-allowlist in https://yourdomain.com/settings/admin/richdocuments
Cloudflare Proxy might block the Turnserver for Nextcloud Talk from working correctly. You might want to disable Cloudflare Proxy thus. See https://github.com/nextcloud/all-in-one/discussions/2463#discussioncomment-5779981
The built-in turn-server for Nextcloud Talk will not work behind Cloudflare Tunnel since it needs a separate port (by default 3478 or as chosen) available on the same domain. If you still want to use the feature, you will need to install your own turnserver or use a publicly available one and adjust and test your stun and turn settings in https://yourdomain.com/settings/admin/talk.
If you get an error in Nextcloud's admin overview that the HSTS header is not set correctly, you might need to enable it in Cloudflare manually.
If you are using AIO's built-in Reverse Proxy and don't use your own, then the certificate issuing may possibly not work out-of-the-box because Cloudflare might block the attempt. In that case you need to disable the Proxy feature at least temporarily in order to make it work. Note that this isn't an option if you need Cloudflare Tunnel as disabling the proxy would also disable Cloudflare Tunnel which would in turn make your server unreachable for the verification. See https://github.com/nextcloud/all-in-one/discussions/1101.

How to run Nextcloud behind a Cloudflare Tunnel?

Although it does not seems like it is the case but from AIO perspective a Cloudflare Tunnel works like a reverse proxy. So please follow the reverse proxy documentation where is documented how to make it run behind a Cloudflare Tunnel. However please see the caveats before proceeding.

How to run Nextcloud via Tailscale?

For a reverse proxy example guide for Tailscale, see this guide by @Perseus333: https://github.com/nextcloud/all-in-one/discussions/6817

How to get a free domain via deSEC?

deSEC offers free dynamic-DNS subdomains under dedyn.io. AIO integrates the registration process directly:

Open the AIO interface and expand the "Don't have a domain? Get a free one from deSEC" section on the domain-entry page.
Enter your email address and, optionally, a desired subdomain slug (the part before .dedyn.io). Leave the slug blank for a random one.
Click Register free domain via deSEC. AIO will create a deSEC account, register the subdomain and store the credentials in its configuration.

After successful registration:

AIO sets the registered *.dedyn.io domain as the Nextcloud domain automatically.
The Caddy community container is enabled as a reverse proxy.
The dnsmasq community container is enabled so that LAN devices can resolve the domain to the server's local IP. Follow the dnsmasq documentation for the required router change.
The mastercontainer keeps the DNS record up to date automatically when your public IP changes.

How to get Nextcloud running using the ACME DNS-challenge?

You can install AIO behind an external reverse proxy where is also documented how to get it running using the ACME DNS-challenge for getting a valid certificate for AIO. See the reverse proxy documentation. (Meant is the Caddy with ACME DNS-challenge section). Also see https://github.com/dani-garcia/vaultwarden/wiki/Running-a-private-vaultwarden-instance-with-Let's-Encrypt-certs#getting-a-custom-caddy-build for additional docs on this topic.

How to run Nextcloud locally? No domain wanted, or wanting intranet access within your LAN.

If you do not want to open Nextcloud to the public internet, you may have a look at the following documentation on how to set it up locally: local-instance.md, but keep in mind you're still required to have https working properly.

Can I use an ip-address for Nextcloud instead of a domain?

No and it will not be added. If you only want to run it locally, you may have a look at the following documentation: local-instance.md. Recommended is to use the built-in deSEC domain registration to get a free domain automatically, or alternatively Tailscale.

Can I run AIO offline or in an airgapped system?

No. This is not possible and will not be added due to multiple reasons: update checks, app installs via app-store, downloading additional docker images on demand and more.

Are self-signed certificates supported for Nextcloud?

No and they will not be. If you want to run it locally, without opening Nextcloud to the public internet, please have a look at the local instance documentation. Recommended is to use the built-in deSEC domain registration to obtain a free domain with a valid certificate automatically, or alternatively Tailscale.

Can I use AIO with multiple domains?

No and it will not be added. However you can use this feature in order to create multiple AIO instances, one for each domain.

Are other ports than the default 443 for Nextcloud supported?

No and they will not be. If port 443 and/or 80 is blocked for you, you may use the built-in deSEC domain registration (which uses the Caddy community container on port 443) or Tailscale if you want to publish it online. If you already run a different service on port 443, please use a dedicated domain for Nextcloud and set it up correctly by following the reverse proxy documentation. However in all cases the Nextcloud interface will redirect you to port 443.

Can I run Nextcloud in a subdirectory on my domain?

No and it will not be added. Please use a dedicated (sub-)domain for Nextcloud and set it up correctly by following the reverse proxy documentation. If you don't have a domain yet, use the built-in deSEC domain registration to get one for free, or alternatively Tailscale.

How can I access Nextcloud locally?

Please note that local access is not possible if you are running AIO behind Cloudflare Tunnel since TLS proxying is in that case offloaded to Cloudflares infrastructure. You can fix this by setting up your own reverse proxy that handles TLS proxying locally and will make the steps below work.

Please make sure that if you are running AIO behind a reverse proxy, that the reverse proxy is configured to use port 443 on the server that runs it. Otherwise the steps below will not work.

Now that this is out of the way, the recommended way how to access Nextcloud locally, is to set up a local dns-server like a pi-hole and set up a custom dns-record for that domain that points to the internal ip-adddress of your server that runs Nextcloud AIO. Below are some guides:

https://www.howtogeek.com/devops/how-to-run-your-own-dns-server-on-your-local-network/
https://help.nextcloud.com/t/need-help-to-configure-internal-access/156075/6
https://howchoo.com/pi/pi-hole-setup together with https://web.archive.org/web/20221203223505/https://docs.callitkarma.me/posts/PiHole-Local-DNS/
https://dockerlabs.collabnix.com/intermediate/networking/Configuring_DNS.html Apart from that there is now a community container that can be added to the AIO stack: https://github.com/nextcloud/all-in-one/tree/main/community-containers/pi-hole

If you registered your domain via the built-in deSEC integration, the dnsmasq community container is automatically enabled and resolves your Nextcloud domain to the server's local IP for LAN clients. You only need to point your router's DHCP DNS server to the AIO host — see the dnsmasq documentation for details.

How to overwrite the local DNS resolution for some domains or add extra hosts to the containers?

For some use cases, you might need to overwrite the local DNS resolution of some domains inside the containers. On Linux, you can do so either by using a local DNS server as described in the section above and add a local DNS entry into the dns server and make your containers use that DNS server.

Another solution on Linux, depending on your network and docker configuration, it might also work to simply edit the /etc/hosts file. Add your custom entry like 172.18.0.1 mail.example.com as additional line to the file and restart docker which should automatically push the entry to all docker containers.

How to skip the domain validation?

If you are completely sure that you've configured everything correctly and are not able to pass the domain validation, you may skip the domain validation by adding --env SKIP_DOMAIN_VALIDATION=true to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used).

Alternatively, if the container is already running, reload the AIO interface with the param skip_domain_validation to skip the domain validation on the fly: e.g. https://ip.address.of.the.server:8080/containers?skip_domain_validation.

How to resolve firewall problems with Fedora Linux, RHEL OS, CentOS, SUSE Linux and others?

It is known that Linux distros that use firewalld as their firewall daemon have problems with docker networks. In case the containers are not able to communicate with each other, you may change your firewalld to use the iptables backend by running:

sudo sed -i 's/FirewallBackend=nftables/FirewallBackend=iptables/g' /etc/firewalld/firewalld.conf
sudo systemctl restart firewalld docker

Afterwards it should work.

See https://dev.to/ozorest/fedora-32-how-to-solve-docker-internal-network-issue-22me for more details on this. This limitation is even mentioned on the official firewalld website: https://firewalld.org/#who-is-using-it

What can I do to fix the internal or reserved ip-address error?

If you get an error during the domain validation which states that your ip-address is an internal or reserved ip-address, you can fix this by first making sure that your domain indeed has the correct public ip-address that points to the server and then adding --add-host yourdomain.com:<public-ip-address> to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) which will allow the domain validation to work correctly. And so that you know: even if the A record of your domain should change over time, this is no problem since the mastercontainer will not make any attempt to access the chosen domain after the initial domain validation.

How to adjust the MTU size of the docker network

You can adjust the MTU size of the docker network by creating it beforehand with the custom MTU:

docker network create --driver bridge --opt com.docker.network.driver.mtu=1440 nextcloud-aio

When you open the AIO interface for the first time after you execute the docker run command, it will automatically connect to the nextcloud-aio network with the custom MTU. Keep in mind that if you previously started the mastercontainer without creating the network with the extra options, you will need to remove the old nextcloud-aio network and recreate it with the new configuration.

If you want to use docker compose, you can check out the comments in the compose.yaml file for more details.

Infrastructure

Which CPU architectures are supported?

You can check this on Linux by running: uname -m

x86_64/x64/amd64
aarch64/arm64/armv8

Disrecommended VPS providers

Older Strato VPS using Virtuozzo caused problems though ones from Q3 2023 and later should work. If your VPS has a /proc/user_beancounters file and a low numproc limit set in it your server will likely misbehave once it reaches this limit which is very quickly reached by AIO, see here.
Hostingers VPS seem to miss a specific Kernel feature which is required for AIO to run correctly. See here.

Recommended VPS

In general recommended VPS are those that are KVM/non-virtualized as Docker should work best on them.

Note on storage options

SD-cards are disrecommended for AIO since they cripple the performance and they are not meant for many write operations which is needed for the database and other parts
SSD storage is recommended
HDD storage should work as well but is of course much slower than SSD storage

Are there known problems when SELinux is enabled?

Yes. If SELinux is enabled, you might need to add the --security-opt label:disable option to the docker run command of the mastercontainer in order to allow it to access the docker socket (or security_opt: ["label:disable"] in compose.yaml). See https://github.com/nextcloud/all-in-one/discussions/485

Customization

How to adjust the internally used docker api version?

If you run an outdated or too new docker version, you might run into problems with the by AIO internally used docker api version. To fix this, you can specify the api version manually. You can do so by adding --env DOCKER_API_VERSION=1.44 to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used). This variable excepts a string based on the pattern [0-9].[0-9]+, so e.g. 1.44. ⚠️ However please note that only the default api version (unset this variable) is supported and tested by the maintainers of Nextcloud AIO. So use this on your own risk and things might break without warning.

How to adjust the log level for AIO components?

You can globally adjust the log level of the included AIO components by adding --env AIO_LOG_LEVEL=warn to the docker run command of the mastercontainer. This setting is propagated from the mastercontainer to the built-in sibling containers. If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command or compose file that you initially used. For troubleshooting, debug and info may additionally re-enable some supervisord child stdout or stderr streams that are normally suppressed in order to keep the default logs concise. Allowed values are error, warn, info and debug.

How to change the default location of Nextcloud's Datadir?

Warning

Do not set or adjust this value after the initial Nextcloud installation is done! If you still want to do it afterwards, see this on how to do it.

You can configure the Nextcloud container to use a specific directory on your host as data directory. You can do so by adding the environmental variable NEXTCLOUD_DATADIR to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used). Allowed values for that variable are strings that start with / and are not equal to /. The chosen directory or volume will then be mounted to /mnt/ncdata inside the container.

An example for Linux is --env NEXTCLOUD_DATADIR="/mnt/ncdata". ⚠️ Please note: If you should be using an external BTRFS drive that is mounted to /mnt/ncdata, make sure to choose a subfolder like e.g. /mnt/ncdata/nextcloud as datadir, since the root folder is not suited as datadir in that case. See https://github.com/nextcloud/all-in-one/discussions/2696.
On macOS it might be --env NEXTCLOUD_DATADIR="/var/nextcloud-data"
For Synology it may be --env NEXTCLOUD_DATADIR="/volume1/docker/nextcloud/data".
On Windows it might be --env NEXTCLOUD_DATADIR="/run/desktop/mnt/host/c/ncdata". (This path is equivalent to C:\ncdata on your Windows host so you need to translate the path accordingly. Hint: the path that you enter needs to start with /run/desktop/mnt/host/. Append to that the exact location on your windows host, e.g. c/ncdata which is equivalent to C:\ncdata.) ⚠️ Please note: This does not work with external drives like USB or network drives and only with internal drives like SATA or NVME drives.
Another option is to provide a specific volume name here with: --env NEXTCLOUD_DATADIR="nextcloud_aio_nextcloud_datadir". This volume needs to be created beforehand manually by you in order to be able to use it. e.g. on Windows with:
```
docker volume create ^
--driver local ^
--name nextcloud_aio_nextcloud_datadir ^
-o device="/host_mnt/e/your/data/path" ^
-o type="none" ^
-o o="bind"
```
In this example, it would mount E:\your\data\path into the volume so for a different location you need to adjust /host_mnt/e/your/data/path accordingly.

How to configure custom UID/GID?

There are two ways to configure custom UIDs or GIDs that will be used inside the installation.

The first and recommended solution is to use Nextcloud's external storage app and use its functionality to add a connection into Nextcloud. See https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/external_storage_configuration_gui.html

Another solution if you really need to use host mounts is to use a bind mount to map custom permissions to the directory. You can do so by editing the /etc/fstab file on your Linux server and create an entry like the following to the file:

/source/path  /target/path/where/the/source/directory/will/be/mounted/on/the/server  fuse.bindfs  force-user=33,force-group=33,allow_other  0  0

Then use sudo mount /target/path/where/the/source/directory/will/be/mounted/on/the/server to mount it directly.

You can afterwards use --env NEXTCLOUD_DATADIR="/target/path/where/the/source/directory/will/be/mounted/on/the/server" as described in the section above.

How to move the appdata folder from the datadir to an ssd to improve the performance?

If the datadir in your setup is configured to be placed on an HDD or network FS like SMB or NFS, you can follow the steps below to change the location of the appdata folder to be located on an SSD in order to improve the performance of the setup.

Note

The following steps only work if you already configured and used NEXTCLOUD_DATADIR as mentioned two sections above. In this example here, we assume that you used NEXTCLOUD_DATADIR="/target/path/.

After the initial installation is done and all datadir files of Nextcloud are stored inside the configured /target/path directory, you will also see an appdata_* folder in there that stores app-related data. You can now move that folder to a faster SSD if the target dir is not already positioned on an SSD by first using rsync to sync the files a location on an SSD. Afterwards rename the appdata folder in the datadir to something like appdata_*-backup. Afterwards add the following line to /etc/fstab:

/source/path/on/ssd  /target/path/<appdata-path>  fuse.bindfs  force-user=33,force-group=33,allow_other  0  0

Do not forget to adjust <appdata-path> to the correct appdata_* name that your installation initially created automatically.

Then use sudo mount /target/path/<appdata-path> to mount it directly.

Afterwards things should be speed up.

How to store the files/installation on a separate drive?

You can move the whole docker library and all its files including all Nextcloud AIO files and folders to a separate drive by first mounting the drive in the host OS (NTFS is not supported and ext4 is recommended as FS) and then following this tutorial: https://www.guguweb.com/2019/02/07/how-to-move-docker-data-directory-to-another-location-on-ubuntu/
(Of course docker needs to be installed first for this to work.)

⚠️ If you encounter errors from richdocuments in your Nextcloud logs, check in your Collabora container if the message "Capabilities are not set for the coolforkit program." appears. If so, follow these steps:

Stop all the containers from the AIO Interface.
Go to your terminal and delete the Collabora container (docker rm nextcloud-aio-collabora) AND the Collabora image (docker image rm nextcloud/aio-collabora).
You might also want to prune your Docker (docker system prune -a) (no data will be lost).
Restart your containers from the AIO Interface.

This should solve the problem.

How to limit the resource usage of AIO?

In some cases, you might want to limit the overall resource usage of AIO. You can do so by following this documentation. Another possibility is to use the manual installation.

How to allow the Nextcloud container to access directories on the host?

By default, the Nextcloud container is confined and cannot access directories on the host OS. You might want to change this when you are planning to use local external storage in Nextcloud to store some files outside the data directory and can do so by adding the environmental variable NEXTCLOUD_MOUNT to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used). Allowed values for that variable are strings that start with / and are not equal to /.

Two examples for Linux are --env NEXTCLOUD_MOUNT="/mnt/" and --env NEXTCLOUD_MOUNT="/media/".
On macOS it might be --env NEXTCLOUD_MOUNT="/Volumes/your_drive/"
For Synology it may be --env NEXTCLOUD_MOUNT="/volume1/".
On Windows it might be --env NEXTCLOUD_MOUNT="/run/desktop/mnt/host/d/your-folder/". (This path is equivalent to D:\your-folder on your Windows host so you need to translate the path accordingly. Hint: the path that you enter needs to start with /run/desktop/mnt/host/. Append to that the exact location on your windows host, e.g. d/your-folder/ which is equivalent to D:\your-folder.) ⚠️ Please note: This does not work with external drives like USB or network drives and only with internal drives like SATA or NVME drives.

After using this option, please make sure to apply the correct permissions to the directories that you want to use in Nextcloud. E.g. sudo chown -R 33:0 /mnt/your-drive-mountpoint and sudo chmod -R 750 /mnt/your-drive-mountpoint should make it work on Linux when you have used --env NEXTCLOUD_MOUNT="/mnt/". On Windows you could do this e.g. with docker exec -it nextcloud-aio-nextcloud chown -R 33:0 /run/desktop/mnt/host/d/your-folder/ and docker exec -it nextcloud-aio-nextcloud chmod -R 750 /run/desktop/mnt/host/d/your-folder/.

You can then navigate to https://your-nc-domain.com/settings/apps/disabled, activate the external storage app, navigate to https://your-nc-domain.com/settings/admin/externalstorages and add a local external storage directory that will be accessible inside the container at the same place that you've entered. E.g. /mnt/your-drive-mountpoint will be mounted to /mnt/your-drive-mountpoint inside the container, etc.

Be aware though that these locations will not be covered by the built-in backup solution - but you can add further Docker volumes and host paths that you want to back up after the initial backup is done.

Note

If you can't see the type "local storage" in the external storage admin options, a restart of the containers from the AIO interface may be required.

How to adjust the Talk port?

By default will the talk container use port 3478/UDP and 3478/TCP for connections. This should be set to something higher than 1024! You can adjust the port by adding e.g. --env TALK_PORT=3478 to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) and adjusting the port to your desired value. Best is to use a port over 1024, so e.g. 3479 to not run into this: https://github.com/nextcloud/all-in-one/discussions/2517

How to adjust the upload limit for Nextcloud?

By default, public uploads to Nextcloud are limited to a max of 16G (logged in users can upload much bigger files using the webinterface or the mobile/desktop clients, since chunking is used in that case). You can adjust the upload limit by providing --env NEXTCLOUD_UPLOAD_LIMIT=16G to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) and customize the value to your fitting. It must start with a number and end with G e.g. 16G.

How to adjust the max execution time for Nextcloud?

By default, uploads to Nextcloud are limited to a max of 3600s. You can adjust the upload time limit by providing --env NEXTCLOUD_MAX_TIME=3600 to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) and customize the value to your fitting. It must be a number e.g. 3600.

How to adjust the PHP memory limit for Nextcloud?

By default, each PHP process in the Nextcloud container is limited to a max of 512 MB. You can adjust the memory limit by providing --env NEXTCLOUD_MEMORY_LIMIT=512M to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) and customize the value to your fitting. It must start with a number and end with M e.g. 1024M.

How to change the Nextcloud apps that are installed on the first startup?

You might want to adjust the Nextcloud apps that are installed upon the first startup of the Nextcloud container. You can do so by adding --env NEXTCLOUD_STARTUP_APPS="deck twofactor_totp tasks calendar contacts notes" to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) and customize the value to your fitting. It must be a string with small letters a-z, 0-9, spaces and hyphens or '_'. You can disable shipped and by default enabled apps by adding a hyphen in front of the appid. E.g. -contactsinteraction.

How to add OS packages permanently to the Nextcloud container?

Some Nextcloud apps require additional external dependencies that must be bundled within Nextcloud container in order to work correctly. As we cannot put each and every dependency for all apps into the container - as this would make the project quickly unmaintainable - there is an official way in which you can add additional dependencies into the Nextcloud container. However note that doing this is disrecommended since we do not test Nextcloud apps that require external dependencies.

You can do so by adding --env NEXTCLOUD_ADDITIONAL_APKS="imagemagick dependency2 dependency3" to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) and customize the value to your fitting. It must be a string with small letters a-z, digits 0-9, spaces, dots and hyphens or '_'. You can find available packages here: https://pkgs.alpinelinux.org/packages?branch=v3.24. By default imagemagick is added. If you want to keep it, you need to specify it as well.

How to add PHP extensions permanently to the Nextcloud container?

Some Nextcloud apps require additional php extensions that must be bundled within Nextcloud container in order to work correctly. As we cannot put each and every dependency for all apps into the container - as this would make the project quickly unmaintainable - there is an official way in which you can add additional php extensions into the Nextcloud container. However note that doing this is disrecommended since we do not test Nextcloud apps that require additional php extensions.

You can do so by adding --env NEXTCLOUD_ADDITIONAL_PHP_EXTENSIONS="imagick extension1 extension2" to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) and customize the value to your fitting. It must be a string with small letters a-z, digits 0-9, spaces, dots and hyphens or '_'. You can find available extensions here: https://pecl.php.net/packages.php. By default imagick is added. If you want to keep it, you need to specify it as well.

What about the pdlib PHP extension for the facerecognition app?

The facerecognition app requires the pdlib PHP extension to be installed. Unfortunately, it is not available on PECL nor via PHP core, so there is no way to add this into AIO currently. However you can use this community container in order to run facerecognition.

How to enable hardware acceleration for Nextcloud?

Some container can use GPU acceleration to increase performance like memories app allows to enable hardware transcoding for videos.

With open source drivers MESA for AMD, Intel and new drivers `Nouveau` for Nvidia

Warning

This only works if the /dev/dri device is present on the host! If it does not exist on your host, don't proceed as otherwise the mastercontainer will fail to start! If you are unsure about this, better do not proceed with the instructions below. Make sure that your driver is correctly configured on the host.

A list of supported device can be fond in MESA 3D documentation.

This method use the Direct Rendering Infrastructure with the access to the /dev/dri device.

In order to use that, you need to pass the /dev/dri device into the mastercontainer by adding --device=/dev/dri to the docker run command (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used). The /dev/dri device gets mounted into the containers that benefit from it.

With this device in place, the AIO mastercontainer automatically detects the /dev/dri device, enables hardware acceleration for the relevant containers and passes the correct render device group to the talk-recording container so that VA-API hardware transcoding (h264_vaapi) is used when recording calls.

With proprietary drivers for Nvidia ⚠️ BETA

Warning

This only works if the Nvidia Toolkit is installed on the host and an NVIDIA GPU is enabled! Make sure that it is correctly configured on the host. If it does not exist on your host, don't proceed as otherwise the Nextcloud container will fail to start! If you are unsure about this, better do not proceed with the instructions below.

This feature is in beta. Since the proprietary, we haven't a lot of user using proprietary drivers, we can't guarantee the stability of this feature. Your feedback is welcome.

This method use the Nvidia Container Toolkit with the nvidia runtime.

In order to use that, you need to add --env NEXTCLOUD_ENABLE_NVIDIA_GPU=true to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) which will enable the nvidia runtime.

The talk-recording container automatically detects the NVIDIA GPU at startup and uses h264_nvenc hardware encoding when available. No additional steps are required beyond enabling the NVIDIA runtime.

If you're using WSL2 and want to use the NVIDIA runtime, please follow the instructions to install the NVIDIA Container Toolkit meta-version in WSL.

How to keep disabled apps?

In certain situations you might want to keep Nextcloud apps that are disabled in the AIO interface and not uninstall them if they should be installed in Nextcloud. You can do so by adding --env NEXTCLOUD_KEEP_DISABLED_APPS=true to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used).

Warning

Doing this might cause unintended problems in Nextcloud if an app that requires an external dependency is still installed but the external dependency not for example.

How to trust user-defined Certification Authorities (CA)?

Note

Please note, that this feature is only intended to make LDAPS connections with self-signed certificates work. It will not make other interconnectivity between the different containers work, as they expect a valid publicly trusted certificate like one from Let's Encrypt.

For some applications it might be necessary to establish a secure connection to another host/server which is using a certificate issued by a Certification Authority that is not trusted out of the box. An example could be configuring LDAPS against a domain controller (Active Directory or Samba-based) of an organization.

You can make the Nextcloud container trust any Certification Authority by providing the environmental variable NEXTCLOUD_TRUSTED_CACERTS_DIR to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used). The value of the variables should be set to the absolute paths of the directory on the host, which contains one or more Certification Authorities certificates. You should use X.509 certificates, Base64 encoded. (Other formats may work but have not been tested!) All the certificates in the directory will be trusted.

When using docker run, the environmental variable can be set with --env NEXTCLOUD_TRUSTED_CACERTS_DIR=/path/to/my/cacerts.

In order for the value to be valid, the path should start with / and not end with / and point to an existing directory. Pointing the variable directly to a certificate file will not work and may also break things.

How to disable Collabora's Seccomp feature?

The Collabora container enables Seccomp by default, which is a security feature of the Linux kernel. On systems without this kernel feature enabled, you need to provide --env COLLABORA_SECCOMP_DISABLED=true to the initial docker run command in order to make it work. If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used.

How to adjust the Fulltextsearch Java options?

The Fulltextsearch Java options are by default set to -Xms512M -Xmx512M which might not be enough on some systems. You can adjust this by adding e.g. --env FULLTEXTSEARCH_JAVA_OPTIONS="-Xms1024M -Xmx1024M" to the initial docker run command. If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used.

Guides

How to run AIO on macOS?

Note

On macOS, it is recommended to use OrbStack instead of Docker Desktop which has much better compatibility with docker for Linux compared to Docker Desktop. See https://orbstack.dev/

Generally, on macOS, there is only one thing different for the docker run command in comparison to Linux: instead of using --volume /var/run/docker.sock:/var/run/docker.sock:ro, you need to use --volume /var/run/docker.sock.raw:/var/run/docker.sock:ro to run it after you installed Docker Desktop (and don't forget to enable ipv6 if you should need that). Apart from that it should work and behave the same like on Linux.

Also, you may be interested in adjusting Nextcloud's Datadir to store the files on the host system. See this documentation on how to do it.

How to run AIO on Windows?

On Windows, install Docker Desktop (and don't forget to enable ipv6 if you should need that) and run the following command in the command prompt:

docker run ^
--init ^
--sig-proxy=false ^
--name nextcloud-aio-mastercontainer ^
--restart always ^
--publish 80:80 ^
--publish 8080:8080 ^
--publish 8443:8443 ^
--volume nextcloud_aio_mastercontainer:/mnt/docker-aio-config ^
--volume //var/run/docker.sock:/var/run/docker.sock:ro ^
ghcr.io/nextcloud-releases/all-in-one:latest

Also, you may be interested in adjusting Nextcloud's Datadir to store the files on the host system. See this documentation on how to do it.

Note

Almost all commands in this project's documentation use sudo docker .... Since sudo is not available on Windows, you simply remove sudo from the commands and they should work.

How to run AIO on Unraid?

Generally on Unraid, before installing Nextcloud AIO, you should make sure to specify a directory for all docker related files instead of using the default docker image before continuing the installation process. See this guide for more details: https://forums.unraid.net/topic/103924-how-to-turn-my-docker-file-to-a-docker-folder/#comment-962317

Additionally, you might need to create a custom user script to start all sibling containers of AIO automatically whenever the server reboots (since the docker plugin in Unraid does not respect the normal docker restart-policy that is configured for all AIO containers). See the User scripts docs: https://docs.unraid.net/unraid-os/using-unraid-to/run-docker-containers/managing-and-customizing-containers/#user-scripts-plugin. You would need to use a script like the one below and use the schedule option @reboot to start the containers automatically.

#!/bin/bash

# Wait 120 seconds for other server components to start correctly
sleep 120

# Execute the actual command
docker exec --env START_CONTAINERS=1 nextcloud-aio-mastercontainer /daily-backup.sh

Apart from that, the installation of AIO should work like on "normal" Linux. So refer to the Linux instructions for installation.

How to run AIO on Synology DSM

On Synology, there are two things different in comparison to Linux: instead of using --volume /var/run/docker.sock:/var/run/docker.sock:ro, you need to use --volume /volume1/docker/docker.sock:/var/run/docker.sock:ro to run it. You also need to add --env WATCHTOWER_DOCKER_SOCKET_PATH="/volume1/docker/docker.sock"to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest). Additionally, you likely need to adjust the internally used api version. See this documentation. Apart from that it should work and behave the same like on Linux. Obviously the Synology Docker GUI will not work with that so you will need to either use SSH or create a user-defined script task in the task scheduler as the user 'root' in order to run the command.

Note

It is possible that the docker socket on your Synology is located in /var/run/docker.sock like the default on Linux. Then you can just use the Linux command without having to change anything - you will notice this when you try to start the container and it says that the bind mount failed. E.g. docker: Error response from daemon: Bind mount failed: '/volume1/docker/docker.sock' does not exists.

Also, you may be interested in adjusting Nextcloud's Datadir to store the files on the host system. See this documentation on how to do it.

You'll also need to adjust Synology's firewall, see below:

Click here to expand

The Synology DSM is vulnerable to attacks with it's open ports and login interfaces, which is why a firewall setup is always recommended. If a firewall is activated it is necessary to have exceptions for ports 80,443, the subnet of the docker bridge which includes the Nextcloud containers, your public static IP (if you don't use DDNS) and if applicable your NC-Talk ports 3478 TCP+UDP:

If you have the NAS setup on your local network (which is most often the case) you will need to setup the Synology DNS to be able to access Nextcloud from your network via its domain. Also don't forget to add the new DNS to your DHCP server and your fixed IP settings:

How to run AIO with Portainer?

The easiest way to run it with Portainer on Linux is to use Portainer's stacks feature and use this docker-compose file in order to start AIO correctly.

Can I run AIO on TrueNAS SCALE?

With the Truenas Scale Release 24.10.0 (which was officially released on October 29th 2024 as a stable release) IX Systems ditched the Kubernetes integration and implemented a fully working docker environment.

For a more complete guide, see this guide by @zybster: https://github.com/nextcloud/all-in-one/discussions/5506

On older TrueNAS SCALE releases with Kubernetes environment, there are two ways to run AIO. The preferred one is to run AIO inside a VM. This is necessary since they do not expose the docker socket for containers on the host, you also cannot use docker-compose on it thus and it is also not possible to run custom helm-charts that are not explicitly written for TrueNAS SCALE.

Another but untested way is to install Portainer on your TrueNAS SCALE from here https://truecharts.org/charts/stable/portainer/installation-notes and add the Helm-chart repository https://nextcloud.github.io/all-in-one/ into Portainer by following https://docs.portainer.io/user/kubernetes/helm. More docs on AIOs Helm Chart are available here: https://github.com/nextcloud/all-in-one/tree/main/nextcloud-aio-helm-chart#nextcloud-aio-helm-chart.

How to run `occ` commands?

Simply run the following: sudo docker exec --user www-data -it nextcloud-aio-nextcloud php occ your-command. Of course your-command needs to be exchanged with the command that you want to run. Please note: If you do not have CLI access to the server, you can now run docker commands via a web session by using this community container: https://github.com/nextcloud/all-in-one/tree/main/community-containers/container-management

How to resolve `Security & setup warnings displays the "missing default phone region" after initial install`?

Simply run the following command: sudo docker exec --user www-data nextcloud-aio-nextcloud php occ config:system:set default_phone_region --value="yourvalue". Of course you need to modify yourvalue based on your location. Examples are DE, US and GB. See this list for more codes: https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2#Officially_assigned_code_elements Please note: If you do not have CLI access to the server, you can now run docker commands via a web session by using this community container: https://github.com/nextcloud/all-in-one/tree/main/community-containers/container-management

How to run multiple AIO instances on one server?

See multiple-instances.md for some documentation on this.

Bruteforce protection FAQ

Nextcloud features a built-in bruteforce protection which may get triggered and will block an ip-address or disable a user. You can unblock an ip-address by running sudo docker exec --user www-data -it nextcloud-aio-nextcloud php occ security:bruteforce:reset <ip-address> and enable a disabled user by running sudo docker exec --user www-data -it nextcloud-aio-nextcloud php occ user:enable <name of user>. See https://docs.nextcloud.com/server/latest/admin_manual/occ_command.html#security-commands-label for further information. Please note: If you do not have CLI access to the server, you can now run docker commands via a web session by using this community container: https://github.com/nextcloud/all-in-one/tree/main/community-containers/container-management

How to switch the channel?

You can switch to a different channel like e.g. the beta channel or from the beta channel back to the latest channel by stopping the mastercontainer, removing it (no data will be lost) and recreating the container using the same command that you used initially to create the mastercontainer. You simply need to change the last line ghcr.io/nextcloud-releases/all-in-one:latest to ghcr.io/nextcloud-releases/all-in-one:beta and vice versa. ⚠️ In some rare occurrences, you might need to run docker pull ghcr.io/nextcloud-releases/all-in-one:latest or docker pull ghcr.io/nextcloud-releases/all-in-one:beta first before being able to use the image.

How to update the containers?

If we push new containers to latest, you will see in the AIO interface below the containers section that new container updates were found. In this case, just press Stop containers and Start and update containers in order to update the containers. The mastercontainer has its own update procedure though. See below. And don't forget to back up the current state of your instance using the built-in backup solution before starting the containers again! Otherwise you won't be able to restore your instance easily if something should break during the update.

If a new mastercontainer update was found, you'll see a note below the Stop containers button that allows to show the changelog. If you click that button and the containers are stopped, you will see a new button that allows to update the mastercontainer. After doing so and after the update is gone through, you will have the option again to Start and update containers. It is recommended to create a backup before clicking the Start and update containers button.

Additionally, there is a cronjob that runs once a day that checks for container and mastercontainer updates and sends a notification to all Nextcloud admins if a new update was found.

How to easily log in to the AIO interface?

If your Nextcloud is running and you are logged in as admin in your Nextcloud, you can easily log in to the AIO interface by opening https://yourdomain.tld/settings/admin/overview which will show a button on top that enables you to log in to the AIO interface by just clicking on this button.

Note

You can change the domain/ip-address/port of the button by simply stopping the containers, visiting the AIO interface from the correct and desired domain/ip-address/port and clicking once on Start containers.

How to change the domain?

Note

Editing the configuration.json manually and making a mistake may break your instance so please create a backup first!

If you set up a new AIO instance, you need to enter a domain. Currently there is no way to change this domain afterwards from the AIO interface. So in order to change it, you need to edit the configuration.json manually using sudo docker run -it --rm --volume nextcloud_aio_mastercontainer:/mnt/docker-aio-config:rw alpine sh -c "apk add --no-cache nano && nano /mnt/docker-aio-config/data/configuration.json", substitute each occurrence of your old domain with your new domain and save and write out the file. Afterwards restart your containers from the AIO interface and everything should work as expected if the new domain is correctly configured.
If you are running AIO behind a web server or reverse proxy (like Apache, Nginx, Caddy, Cloudflare Tunnel and else), you need to obviously also change the domain in your reverse proxy config.

Additionally, after restarting the containers, you need to open the admin settings and update some values manually that cannot be changed automatically. Here is a list of some known places:

https://your-nc-domain.com/settings/admin/talk for Turn/Stun server and Signaling Server if you enabled Talk via the AIO interface
https://your-nc-domain.com/settings/admin/theming for the theming URL
https://your-nc-domain.com/settings/admin/app_api for the deploy daemon if you enabled the App API via the AIO interface

How to properly reset the instance?

If something goes unexpected routes during the initial installation, you might want to reset the AIO installation to be able to start from scratch.

Note

If you already have it running and have data on your instance, you should not follow these instructions as it will delete all data that is coupled to your AIO instance.

Here is how to reset the AIO instance properly:

Stop all containers if they are running from the AIO interface
Stop the mastercontainer with sudo docker stop nextcloud-aio-mastercontainer
If the domaincheck container is still running, stop it with sudo docker stop nextcloud-aio-domaincheck
Check that no AIO containers are running anymore by running sudo docker ps --format {{.Names}}. If no nextcloud-aio containers are listed, you can proceed with the steps below. If there should be some, you will need to stop them with sudo docker stop <container_name> until no one is listed anymore.
Check which containers are stopped: sudo docker ps --filter "status=exited"
Now remove all these stopped containers with sudo docker container prune
Delete the docker network with sudo docker network rm nextcloud-aio
Check which volumes are dangling with sudo docker volume ls --filter "dangling=true"
Now remove all these dangling volumes: sudo docker volume prune --filter all=1 (on Windows you might need to remove some volumes afterwards manually with docker volume rm nextcloud_aio_backupdir, docker volume rm nextcloud_aio_nextcloud_datadir).
If you've configured NEXTCLOUD_DATADIR to a path on your host instead of the default volume, you need to clean that up as well. (E.g. by simply deleting the directory).
Make sure that no volumes are remaining with sudo docker volume ls --format {{.Name}}. If no nextcloud-aio volumes are listed, you can proceed with the steps below. If there should be some, you will need to remove them with sudo docker volume rm <volume_name> until no one is listed anymore.
Optional: You can remove all docker images with sudo docker image prune -a.
And you are done! Now feel free to start over with the recommended docker run command!

Can I use a CIFS/SMB share as Nextcloud's datadir?

Sure. Add this to the /etc/fstab file on the host system:
<your-storage-host-and-subpath> <your-mount-dir> cifs rw,mfsymlinks,seal,credentials=<your-credentials-file>,uid=33,gid=0,file_mode=0770,dir_mode=0770 0 0
(Of course you need to modify <your-storage-host-and-subpath>, <your-mount-dir> and <your-credentials-file> for your specific case.)

One example could look like this:
//your-storage-host/subpath /mnt/storagebox cifs rw,mfsymlinks,seal,credentials=/etc/storage-credentials,uid=33,gid=0,file_mode=0770,dir_mode=0770 0 0
and add into /etc/storage-credentials:

username=<smb/cifs username>
password=<password>

(Of course you need to modify <smb/cifs username> and <password> for your specific case.)

Now you can use /mnt/storagebox as Nextcloud's datadir like described in the section here.

Note

You also might want to move the appdata dir after the initial installation is done to improve the performance. See this section

Can I run this with Docker swarm?

Yes. For that to work, you need to use and follow the manual-install documentation.

Can I run this with Kubernetes?

Yes. For that to work, you need to use and follow the helm-chart documentation.

How to run this with Docker rootless?

You can run AIO also with docker rootless. How to do this is documented here: docker-rootless.md

Can I run this with Podman instead of Docker?

Since Podman is not 100% compatible with the Docker API, Podman is not supported (since that would add yet another platform where the maintainer would need to test on). However you can use and follow the manual-install documentation to get AIO's containers running with Podman or use Docker rootless, as described in the above section. Also there is this now: https://github.com/nextcloud/all-in-one/discussions/3487

Access/Edit Nextcloud files/folders manually

The files and folders that you add to Nextcloud are by default stored in the following docker directory: nextcloud_aio_nextcloud:/mnt/ncdata/ (usually /var/lib/docker/volumes/nextcloud_aio_nextcloud_data/_data/ on linux host systems). If needed, you can modify/add/delete files/folders there but ATTENTION: be very careful when doing so because you might corrupt your AIO installation! Best is to create a backup using the built-in backup solution before editing/changing files/folders in there because you will then be able to restore your instance to the backed up state.

After you are done modifying/adding/deleting files/folders, don't forget to apply the correct permissions by running: sudo docker exec nextcloud-aio-nextcloud chown -R 33:0 /mnt/ncdata/ and sudo docker exec nextcloud-aio-nextcloud chmod -R 750 /mnt/ncdata/ and rescan the files with sudo docker exec --user www-data -it nextcloud-aio-nextcloud php occ files:scan --all. Please note: If you do not have CLI access to the server, you can now run docker commands via a web session by using this community container: https://github.com/nextcloud/all-in-one/tree/main/community-containers/container-management

How to edit Nextclouds config.php file with a texteditor?

You can edit Nextclouds config.php file directly from the host with your favorite text editor. E.g. like this: sudo docker run -it --rm --volume nextcloud_aio_nextcloud:/var/www/html:rw alpine sh -c "apk add --no-cache nano && nano /var/www/html/config/config.php". Make sure to not break the file though which might corrupt your Nextcloud instance otherwise. In best case, create a backup using the built-in backup solution before editing the file. Please note: If you do not have CLI access to the server, you can now run docker commands via a web session by using this community container: https://github.com/nextcloud/all-in-one/tree/main/community-containers/container-management

How to change default files by creating a custom skeleton directory?

All users see a set of default files and folders as dictated by Nextcloud's configuration. To change these default files and folders a custom skeleton directory must first be created; this can be accomplished by copying your skeleton files sudo docker cp --follow-link /path/to/nextcloud/skeleton/ nextcloud-aio-nextcloud:/mnt/ncdata/skeleton/, applying the correct permissions with sudo docker exec nextcloud-aio-nextcloud chown -R 33:0 /mnt/ncdata/skeleton/ and sudo docker exec nextcloud-aio-nextcloud chmod -R 750 /mnt/ncdata/skeleton/ and setting the skeleton directory option with sudo docker exec --user www-data -it nextcloud-aio-nextcloud php occ config:system:set skeletondirectory --value="/mnt/ncdata/skeleton". Further information is available in the Nextcloud documentation on configuration parameters for the skeleton directory.

How to adjust the version retention policy and trashbin retention policy?

By default, AIO sets the versions_retention_obligation and trashbin_retention_obligation both to auto, 30 which means that versions and items in the trashbin get deleted after 30 days. If you want to change this, see https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/file_versioning.html.

How to enable automatic updates without creating a backup beforehand?

If you have an external backup solution, you might want to enable automatic updates without creating a backup first. However note that doing this is disrecommended since you will not be able to easily create and restore a backup from the AIO interface anymore and you need to make sure to shut down all the containers properly before creating the backup, e.g. by stopping them from the AIO interface first.

But anyhow, is here a guide that helps you automate the whole procedure:

Click here to expand

#!/bin/bash

# Stop the containers
docker exec --env STOP_CONTAINERS=1 nextcloud-aio-mastercontainer /daily-backup.sh

# Below is optional if you run AIO in a VM which will shut down the VM afterwards
# poweroff

You can simply copy and paste the script into a file e.g. named shutdown-script.sh e.g. here: /root/shutdown-script.sh.

Afterwards apply the correct permissions with sudo chown root:root /root/shutdown-script.sh and sudo chmod 700 /root/shutdown-script.sh. Then you can create a cronjob that runs it on a schedule e.g. runs the script at 04:00 each day like this:

Open the cronjob with sudo crontab -u root -e (and choose your editor of choice if not already done. I'd recommend nano).
Add the following new line to the crontab if not already present: 0 4 * * * /root/shutdown-script.sh which will run the script at 04:00 each day.
save and close the crontab (when using nano the shortcuts for this are Ctrl + o and then Enter to save, and close the editor with Ctrl + x).

After that is in place, you should schedule a backup from your backup solution that creates a backup after AIO is shut down properly. Hint: If your backup runs on the same host, make sure to at least back up all docker volumes and additionally Nextcloud's datadir if it is not stored in a docker volume.

Afterwards, you can create a second script that automatically updates the containers:

Click here to expand

#!/bin/bash

# Run container update once
if ! docker exec --env AUTOMATIC_UPDATES=1 nextcloud-aio-mastercontainer /daily-backup.sh; then
    while docker ps --format "{{.Names}}" | grep -q "^nextcloud-aio-watchtower$"; do
        echo "Waiting for watchtower to stop"
        sleep 30
    done

    while ! docker ps --format "{{.Names}}" | grep -q "^nextcloud-aio-mastercontainer$"; do
        echo "Waiting for Mastercontainer to start"
        sleep 30
    done

    # Run container update another time to make sure that all containers are updated correctly.
    docker exec --env AUTOMATIC_UPDATES=1 nextcloud-aio-mastercontainer /daily-backup.sh
fi

You can simply copy and paste the script into a file e.g. named automatic-updates.sh e.g. here: /root/automatic-updates.sh.

Afterwards apply the correct permissions with sudo chown root:root /root/automatic-updates.sh and sudo chmod 700 /root/automatic-updates.sh. Then you can create a cronjob that runs e.g. at 05:00 each day like this:

Open the cronjob with sudo crontab -u root -e (and choose your editor of choice if not already done. I'd recommend nano).
Add the following new line to the crontab if not already present: 0 5 * * * /root/automatic-updates.sh which will run the script at 05:00 each day.
save and close the crontab (when using nano the shortcuts for this are Ctrl + o then Enter to save, and close the editor with Ctrl + x).

Securing the AIO interface from unauthorized ACME challenges

By design, Caddy that runs inside the mastercontainer, which handles automatic TLS certificate generation for the AIO interface on port 8443, is configured to accept traffic on any valid domain in order to make the AIO interface as convenient to use as possible. However due to this, it is vulnerable to receiving DNS challenges for arbitrary hostnames from anyone on the internet. While this does not compromise your server's security, it can result in cluttered logs and rejected certificate renewal attempts due to rate limit abuse. To mitigate this issue, it is recommended to place the AIO interface behind a VPN and/or limit its public exposure.

How to migrate from an already existing Nextcloud installation to Nextcloud AIO?

Please see the following documentation on this: migration.md

Backup

Nextcloud AIO provides a backup solution based on BorgBackup. These backups act as a restore point in case the installation gets corrupted. By using this tool, backups are incremental, differential, compressed and encrypted – so only the first backup will take a while. Further backups should be fast as only changes are taken into account.

It is recommended to create a backup before any container update. By doing this, you will be safe regarding any possible complication during updates because you will be able to restore the whole instance with basically one click.

For local backups, the restore process should be pretty fast as rsync is used to restore the chosen backup which only transfers changed files and deletes additional ones. For remote borg backups, the whole backup archive is extracted from the remote, which depending on how clever borg extract is, may require downloading the whole archive.

If you connect an external drive to your host, and choose the backup directory to be on that drive, you are also kind of safe against drive failures of the drive where the docker volumes are stored on.

How to do the above step for step

Mount an external/backup HDD to the host OS using the built-in functionality or udev rules or whatever way you prefer. (E.g. follow this video: https://www.youtube.com/watch?v=2lSyX4D3v_s) and mount the drive in best case in /mnt/backup.
If not already done, fire up the docker container and set up Nextcloud as per the guide.
Now open the AIO interface.
Under backup section, add your external disk mountpoint as backup directory, e.g. /mnt/backup.
Click on Create Backup which should create the first backup on the external disk.

If you want to back up directly to a remote borg repository:

How to do the above step for step

Create your borg repository at the remote. Note down the repository URL for later.
Open the AIO interface
Under backup section, leave the local path blank and fill in the url to your borg repository that you noted down earlier.
Click on Create backup, this will create an ssh key pair and fail because the remote doesn't trust this key yet. Copy the public key shown in AIO and add it to your authorized keys on the remote.
Try again to create a backup, this time it should succeed.

Backups can be created and restored in the AIO interface using the buttons Create Backup and Restore selected backup. Additionally, a backup check is provided that checks the integrity of your backups but it shouldn't be needed in most situations.

The backups themselves get encrypted with an encryption key that gets shown to you in the AIO interface. Please save that at a safe place as you will not be able to restore from backup without this key.

Daily backups can get enabled after the initial backup is done. Enabling this also allows to enable an option that allows to automatically update all containers, Nextcloud and its apps.

Be aware that this solution does not back up files and folders that are mounted into Nextcloud using the external storage app - but you can add further Docker volumes and host paths that you want to back up after the initial backup is done.

What is getting backed up by AIO's backup solution?

Backed up will get all important data of your Nextcloud AIO instance required to restore the instance, like the database, your files and configuration files of the mastercontainer and else. Files and folders that are mounted into Nextcloud using the external storage app are not getting backed up. If you don't want your datadirectory to be backed up, see https://github.com/nextcloud/all-in-one#how-to-enable-automatic-updates-without-creating-a-backup-beforehand for options (there is a hint what needs to be backed up in which order).

How to adjust borgs retention policy?

The built-in borg-based backup solution has by default a retention policy of --keep-within=7d --keep-weekly=4 --keep-monthly=6. See https://borgbackup.readthedocs.io/en/stable/usage/prune.html for what these values mean. You can adjust the retention policy by providing --env BORG_RETENTION_POLICY="--keep-within=7d --keep-weekly=4 --keep-monthly=6" to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used) and customize the value to your fitting. ⚠️ Please make sure that this value is valid, otherwise backup pruning will bug out! Also, don't include the -a or --glob-archives option, since AIO already provides it and you can't override it. See https://github.com/nextcloud/all-in-one/pull/7616

How to migrate from AIO to AIO?

If you have the borg backup feature enabled, you can copy it over to the new host and restore from the backup. This guide assumes the new installation data dir will be on /mnt/datadir, you can adjust the steps if it's elsewhere.

Set the DNS entry to 60 seconds TTL if applicable
On your current installation, use the AIO interface to:
1. Update AIO and all containers
2. Stop all containers (from now on, your cloud is down)
3. Create a current borg backup
4. Note the path where the backups are stored and the encryption password
Navigate to the backup folder
Create archive of the backup so it's easier to copy: tar -czvf borg.tar.gz borg
Copy the archive over to the new host: scp borg.tar.gz user@new.host:/mnt. Make sure to replace user with your actual user and new.host with the IP or domain of the actual host. You can also use another way to copy the archive.
Switch to the new host
Go to the folder you put the backup archive and extract it with tar -xf borg.tar.gz
Follow the installation guide to create a new aio instance, but do not start the containers yet (the docker run or docker compose up -d command)
Change the DNS entry to the new host's IP
Configure your reverse proxy if you use one
Start the AIO container and open the new AIO interface in your browser
Make sure to save the newly generated passphrase and enter it in the next step
Select the "Restore former AIO instance from backup" option and enter the encryption password from the old backup and the path in which the extracted borg folder lies in (without the borg part) and hit Submit location and password
Choose the latest backup in the dropdown and hit Restore selected backup
Wait until the backup is restored
Start the containers in the AIO interface

Are remote borg backups supported?

Backing up directly to a remote borg repository is supported. This avoids having to store a local copy of your backups, supports append-only borg keys to counter ransomware and allows using the AIO interface to manage your backups.

Some alternatives, which do not have all the above benefits:

Mount a network FS like SSHFS, SMB or NFS in the directory that you enter in AIO as backup directory
Use rsync or rclone for syncing the borg backup archive that AIO creates locally to a remote target (make sure to lock the backup archive correctly before starting the sync; search for "aio-lockfile"; you can find a local example script here: https://github.com/nextcloud/all-in-one#sync-local-backups-regularly-to-another-drive)
You can find a well written guide that uses rclone and e.g. BorgBase for remote backups here: https://github.com/nextcloud/all-in-one/discussions/2247
Here is another one that utilizes borgmatic and BorgBase for remote backups: https://github.com/nextcloud/all-in-one/discussions/4391
create your own backup solution using a script and borg, borgmatic or any other to backup tool for backing up to a remote target (make sure to stop and start the AIO containers correctly following https://github.com/nextcloud/all-in-one#how-to-enable-automatic-updates-without-creating-a-backup-beforehand)

Failure of the backup container in LXC containers

If you are running AIO in a LXC container, you need to make sure that FUSE is enabled in the LXC container settings. Also, if using Alpine Linux as host OS, make sure to add fuse via apk add fuse. Otherwise the backup container will not be able to start as FUSE is required for it to work.

How to create the backup volume on Windows?

As stated in the AIO interface, it is possible to use a docker volume as backup target. Before you can use that, you need to create it first. Here is an example how to create one on Windows:

docker volume create ^
--driver local ^
--name nextcloud_aio_backupdir ^
-o device="/host_mnt/e/your/backup/path" ^
-o type="none" ^
-o o="bind"

In this example, it would mount E:\your\backup\path into the volume so for a different location you need to adjust /host_mnt/e/your/backup/path accordingly. Afterwards enter nextcloud_aio_backupdir in the AIO interface as backup location.

Pro-tip: Backup archives access

You can open the BorgBackup archives on your host by following these steps:
(instructions for Ubuntu Desktop)

Alternatively, there is now a community container that allows to access your backups in a web session: https://github.com/nextcloud/all-in-one/tree/main/community-containers/borgbackup-viewer.

# Install borgbackup on the host
sudo apt update && sudo apt install borgbackup

# In any shell where you use borg, you must first export this variable
# If you are using the default backup location /mnt/backup/borg
export BORG_REPO='/mnt/backup/borg'
# or if you are using a remote repository
export BORG_REPO='user@host:/path/to/repo'

# Mount the archives to /tmp/borg
sudo mkdir -p /tmp/borg && sudo borg mount "$BORG_REPO" /tmp/borg

# After entering your repository key successfully, you should be able to access all archives in /tmp/borg
# You can now do whatever you want by syncing them to a different place using rsync or doing other things
# E.g. you can open the file manager on that location by running:
xhost +si:localuser:root && sudo nautilus /tmp/borg

# When you are done, simply close the file manager and run the following command to unmount the backup archives:
sudo umount /tmp/borg

Delete backup archives manually

You can delete BorgBackup archives on your host manually by following these steps:
(instructions for Debian based OS' like Ubuntu)

Alternatively, there is now a community container that allows to access your backups in a web session: https://github.com/nextcloud/all-in-one/tree/main/community-containers/borgbackup-viewer.

# Install borgbackup on the host
sudo apt update && sudo apt install borgbackup

# In any shell where you use borg, you must first export this variable
# If you are using the default backup location /mnt/backup/borg
export BORG_REPO='/mnt/backup/borg'
# or if you are using a remote repository
export BORG_REPO='user@host:/path/to/repo'

# List all archives (if you are using the default backup location /mnt/backup/borg)
sudo borg list

# After entering your repository key successfully, you should now see a list of all backup archives
# An example backup archive might be called 20220223_174237-nextcloud-aio
# Then you can simply delete the archive with:
sudo borg delete --stats --progress "::20220223_174237-nextcloud-aio"

# If borg 1.2.0 or higher is installed, you then need to run borg compact in order to clean up the freed space
sudo borg --version
# If version number of the command above is higher than 1.2.0 you need to run the command below:
sudo borg compact

After doing so, make sure to update the backup archives list in the AIO interface!
You can do so by clicking on the Update backup list button in the Update backup list section inside the Backup and restore section.

Sync local backups regularly to another drive

For increased backup security, you might consider syncing the local backup repository regularly to another drive.

To do that, first add the drive to /etc/fstab so that it is able to get automatically mounted and then create a script that does all the things automatically. Here is an example for such a script:

Click here to expand

#!/bin/bash

# Please modify all variables below to your needings:
SOURCE_DIRECTORY="/mnt/backup/borg"
DRIVE_MOUNTPOINT="/mnt/backup-drive"
TARGET_DIRECTORY="/mnt/backup-drive/borg"

########################################
# Please do NOT modify anything below! #
########################################

if [ "$EUID" -ne 0 ]; then 
    echo "Please run as root"
    exit 1
fi

if ! [ -d "$SOURCE_DIRECTORY" ]; then
    echo "The source directory does not exist."
    exit 1
fi

if [ -z "$(ls -A "$SOURCE_DIRECTORY/")" ]; then
    echo "The source directory is empty which is not allowed."
    exit 1
fi

if ! [ -d "$DRIVE_MOUNTPOINT" ]; then
    echo "The drive mountpoint must be an existing directory"
    exit 1
fi

if ! grep -q "$DRIVE_MOUNTPOINT" /etc/fstab; then
    echo "Could not find the drive mountpoint in the fstab file. Did you add it there?"
    exit 1
fi

if ! mountpoint -q "$DRIVE_MOUNTPOINT"; then
    mount "$DRIVE_MOUNTPOINT"
    if ! mountpoint -q "$DRIVE_MOUNTPOINT"; then
        echo "Could not mount the drive. Is it connected?"
        exit 1
    fi
fi

if [ -f "$SOURCE_DIRECTORY/lock.roster" ]; then
    echo "Cannot run the script as the backup archive is currently changed. Please try again later."
    exit 1
fi

mkdir -p "$TARGET_DIRECTORY"
if ! [ -d "$TARGET_DIRECTORY" ]; then
    echo "Could not create target directory"
    exit 1
fi

if [ -f "$SOURCE_DIRECTORY/aio-lockfile" ]; then
    echo "Not continuing because aio-lockfile already exists."
    exit 1
fi

touch "$SOURCE_DIRECTORY/aio-lockfile"

if ! rsync --stats --archive --human-readable --delete "$SOURCE_DIRECTORY/" "$TARGET_DIRECTORY"; then
    echo "Failed to sync the backup repository to the target directory."
    exit 1
fi

rm "$SOURCE_DIRECTORY/aio-lockfile"
rm "$TARGET_DIRECTORY/aio-lockfile"

umount "$DRIVE_MOUNTPOINT"

if docker ps --format "{{.Names}}" | grep "^nextcloud-aio-nextcloud$"; then
    docker exec nextcloud-aio-nextcloud bash /notify.sh "Rsync backup successful!" "Synced the backup repository successfully."
else
    echo "Synced the backup repository successfully."
fi

You can simply copy and paste the script into a file e.g. named backup-script.sh e.g. here: /root/backup-script.sh. Do not forget to modify the variables to your requirements!

Afterwards apply the correct permissions with sudo chown root:root /root/backup-script.sh and sudo chmod 700 /root/backup-script.sh. Then you can create a cronjob that runs e.g. at 20:00 each week on Sundays like this:

Open the cronjob with sudo crontab -u root -e (and choose your editor of choice if not already done. I'd recommend nano).
Add the following new line to the crontab if not already present: 0 20 * * 7 /root/backup-script.sh which will run the script at 20:00 on Sundays each week.
save and close the crontab (when using nano are the shortcuts for this Ctrl + o -> Enter and close the editor with Ctrl + x).

How to exclude Nextcloud's data directory or the preview folder from backup?

In order to speed up the backups and to keep the backup archives small, you might want to exclude Nextcloud's data directory or its preview folder from backup.

Warning

However please note that you will run into problems if the database and the data directory or preview folder get out of sync. So please only read further, if you have an additional external backup of the data directory! See this guide for example.

Tip

A better option is to use the external storage app inside Nextcloud as the data connected via the external storage app is not backed up by AIO's backup solution. See this documentation on how to configure the app.

If you still want to proceed, you can exclude the data directory by simply creating a .noaiobackup file in the root directory of the specified NEXTCLOUD_DATADIR target. The same logic is implemented for the preview folder that is located inside the data directory, inside the appdata_*/preview folder. So simply create a .noaiobackup file in there if you want to exclude the preview folder.

After doing a restore via the AIO interface, you might run into problems due to the data directory and database being out of sync. You might be able to fix this by running occ files:scan --all and occ maintenance:repair and occ files:scan-app-data. See https://github.com/nextcloud/all-in-one#how-to-run-occ-commands. If only the preview folder is excluded, the command occ files:scan-app-data preview should be used.

How to stop/start/update containers or trigger the daily backup from a script externally?

Warning

The below script will only work after the initial setup of AIO. So you will always need to first visit the AIO interface, type in your domain and start the containers the first time or restore an older AIO instance from its borg backup before you can use the script.

You can do so by running the /daily-backup.sh script that is stored in the mastercontainer. It accepts the following environment variables:

AUTOMATIC_UPDATES if set to 1, it will automatically stop the containers, update them and start them including the mastercontainer. If the mastercontainer gets updated, this script's execution will stop as soon as the mastercontainer gets stopped. You can then wait until it is started again and run the script with this flag again in order to update all containers correctly afterwards.
DAILY_BACKUP if set to 1, it will automatically stop the containers and create a backup. If you want to start them again afterwards, you may have a look at the START_CONTAINERS option.
STOP_CONTAINERS if set to 1, it will automatically stop the containers at the start of the script. Implied by DAILY_BACKUP=1.
START_CONTAINERS if set to 1, it will automatically start the containers at the end of the script, without updating them. Implied by AUTOMATIC_UPDATES=1.
CHECK_BACKUP if set to 1, it will start the integrity check of all borg backups made by AIO. Note that the backup check is non blocking so containers can be kept running while the check lasts. That means you can't pass DAILY_BACKUP=1 at the same time. The output of the check can be found in the logs of the container nextcloud-aio-borgbackup.

One example to do a backup would be sudo docker exec -it --env DAILY_BACKUP=1 nextcloud-aio-mastercontainer /daily-backup.sh, which you can run via a cronjob or put it in a script.

Likewise to do a backup check would be sudo docker exec --env DAILY_BACKUP=0 --env CHECK_BACKUP=1 --env STOP_CONTAINERS=0 nextcloud-aio-mastercontainer /daily-backup.sh.

Note

None of the option returns error codes. So you need to check for the correct result yourself.

How to disable the backup section?

If you already have a backup solution in place, you may want to hide the backup section. You can do so by adding --env AIO_DISABLE_BACKUP_SECTION=true to the docker run command of the mastercontainer (but before the last line ghcr.io/nextcloud-releases/all-in-one:latest! If it was started already, you will need to stop the mastercontainer, remove it (no data will be lost) and recreate it using the docker run command that you initially used).

Addons

Fail2ban

You can configure your server to block certain ip-addresses using fail2ban as bruteforce protection. Here is how to set it up: https://docs.nextcloud.com/server/stable/admin_manual/installation/harden_server.html#setup-fail2ban. The logpath of AIO is by default /var/lib/docker/volumes/nextcloud_aio_nextcloud/_data/data/nextcloud.log. Do not forget to add chain=DOCKER-USER to your nextcloud jail config (nextcloud.local) otherwise the nextcloud service running on docker will still be accessible even if the IP is banned. Also, you may change the blocked ports to cover all AIO ports: by default 80,443,8080,8443,3478 (see this). Apart from that there is now a community container that can be added to the AIO stack: https://github.com/nextcloud/all-in-one/tree/main/community-containers/fail2ban

LDAP

It is possible to connect to an existing LDAP server. You need to make sure that the LDAP server is reachable from the Nextcloud container. Then you can enable the LDAP app and configure LDAP in Nextcloud manually. If you don't have a LDAP server yet, recommended is to use this docker container: https://hub.docker.com/r/nitnelave/lldap. Make sure here as well that Nextcloud can talk to the LDAP server. The easiest way is by adding the LDAP docker container to the docker network nextcloud-aio. Then you can connect to the LDAP container by its name from the Nextcloud container. There is now a community container which allows to easily add LLDAP to AIO: https://github.com/nextcloud/all-in-one/tree/main/community-containers/lldap

Netdata

Netdata allows you to monitor your server using a GUI. You can install it by following https://learn.netdata.cloud/docs/agent/packaging/docker#create-a-new-netdata-agent-container. Apart from that there is now a way for the community to add containers: https://github.com/nextcloud/all-in-one/discussions/392#discussioncomment-7133563

USER_SQL

If you want to use the user_sql app, the easiest way is to create an additional database container and add it to the docker network nextcloud-aio. Then the Nextcloud container should be able to talk to the database container using its name.

phpMyAdmin, Adminer or pgAdmin

It is possible to install any of these to get a GUI for your AIO database. The pgAdmin container is recommended. You can get some docs on it here: https://www.pgadmin.org/docs/pgadmin4/latest/container_deployment.html. For the container to connect to the aio-database, you need to connect the container to the docker network nextcloud-aio and use nextcloud-aio-database as database host, oc_nextcloud as database username and the password that you get when running sudo docker exec nextcloud-aio-nextcloud grep dbpassword config/config.php as the password. Apart from that there is now a dedicated Nextcloud app: https://github.com/nextcloud/dbdoctor. Please note: If you do not have CLI access to the server, you can now run docker commands via a web session by using this community container: https://github.com/nextcloud/all-in-one/tree/main/community-containers/container-management

Mail server

You can configure one yourself by using either of these four recommended projects: Docker Mailserver, Mailu, Maddy Mail Server, Mailcow or Stalwart. There is now a community container which allows to easily add Stalwart Mail server to AIO: https://github.com/nextcloud/all-in-one/tree/main/community-containers/stalwart

Miscellaneous

Requirements for integrating new containers

For integrating new containers, they must pass specific requirements for being considered to get integrated in AIO itself. Even if not considered, we may add some documentation on it. Also there is this now: https://github.com/nextcloud/all-in-one/tree/main/community-containers#community-containers

What are the requirements?

New containers must be related to Nextcloud. Related means that there must be a feature in Nextcloud that gets added by adding this container.
It must be optionally installable. Disabling and enabling the container from the AIO interface must work and must not produce any unexpected side-effects.
The feature that gets added into Nextcloud by adding the container must be maintained by the Nextcloud GmbH.
It must be possible to run the container without big quirks inside docker containers. Big quirks means e.g. needing to change the capabilities or security options.
The container should not mount directories from the host into the container: only docker volumes should be used.
The container must be usable by more than 90% of the users (e.g. not too high system requirements and such)
No additional setup should be needed after adding the container - it should work completely out of the box.
If the container requires being exposed, only subfolders are supported. So the container should not require its own (sub-)domain and must be able to run in a subfolder.

AIO release policy

We release new versions of this project under the rules of Semantic Versioning.
A new beta version shall be released roughly every two weeks. In urgent cases it might happen in quicker succession.
Each beta release gets roughly 7 days to be tested. If during that time no issues arise, the version is promoted to a final release.
If issues in a beta release are found they are treated with higher priority, and fixes for those issues are published in a new beta release with increased version number. For the former beta release version number no final release gets published. (We don't do multiple beta releases, or release candidates, for a version number.)

Nextcloud update policy

This project values stability over new features. That means that when a new major Nextcloud update gets introduced, we will wait at least until the first patch release, e.g. 24.0.1 is out before upgrading to it. Also we will wait with the upgrade until all important apps are compatible with the new major version. Minor or patch releases for Nextcloud and all dependencies as well as all containers will be updated to new versions as soon as possible but we try to give all updates first a good test round before pushing them. That means that it can take around 2 weeks before new updates reach the latest channel. If you want to help testing, you can switch to the beta channel by following this documentation which will also give you the updates earlier.

How often are update notifications sent?

AIO ships its own update notifications implementation. It checks if container updates are available. If so, it sends a notification with the title Container updates available! on saturdays to Nextcloud users that are part of the admin group. If the Nextcloud container image should be older than 90 days (~3 months) and thus badly outdated, AIO sends a notification to all Nextcloud users with the title AIO is outdated!. Thus admins should make sure to update the container images at least once every 3 months in order to make sure that the instance gets all security bugfixes as soon as possible.

Huge docker logs

If you should run into issues with huge docker logs, you can adjust the log size by following https://docs.docker.com/config/containers/logging/local/#usage. You can additionally reduce the verbosity of the included AIO containers by setting AIO_LOG_LEVEL=error on the mastercontainer. By default, AIO keeps the existing component-specific log defaults, so this should usually not be needed.

Badges

PrestaShop/PrestaShop

PrestaShop is the universal open-source software platform to build your e-commerce solution.

About PrestaShop

PrestaShop is an Open Source e-commerce web application, committed to providing the best shopping cart experience for both merchants and customers. It is written in PHP, is highly customizable, supports all the major payment services, is translated in many languages and localized for many countries, has a fully responsive design (both front and back office), etc. See all the available features.

This repository contains the source code of PrestaShop, which is intended for development and preview only. To download the latest stable public version of PrestaShop (currently, version 9.0), please go to the releases page.

The first stable version of PrestaShop 9.0 was released on June 10th, 2025. Learn more about it on the Build devblog.

About the `develop` branch

The develop branch of this repository contains the work in progress source code for the next version of PrestaShop. Currently, it is exclusively for version 9.1.

For more information on our branch system, read our guide on installing PrestaShop for development.

Server configuration

To install the latest PrestaShop 9.0, you need a web server running PHP 8.1+ and any flavor of MySQL 5.6+ (MySQL, MariaDB, Percona Server, etc.).

You will also need a database administration tool, such as phpMyAdmin, in order to create a database for PrestaShop. We recommend the Apache or Nginx web servers (check out our example Nginx configuration file).

You can find more information on our System requirements page and on the System Administrator Guide.

Installation

If you downloaded the source code from GitHub, read our guide on installing PrestaShop for development. If you intend to install a production shop, make sure to download the latest version from our releases page, then read the install guide for users.

🐳 Docker Development Environment

PrestaShop provides a complete Docker-based development environment.

Quick Start

# Start the development environment
make docker-start

# Access your PrestaShop installation
# Frontend: http://localhost:8001
# Backend: http://localhost:8001/admin-dev
# Email testing: http://localhost:1080

Default Admin Credentials:

Email: demo@prestashop.com
Password: Pr3st4Sh0P

Or the backoffice on this URL: http://localhost:8001/admin-dev (default access credentials: demo@prestashop.com / Pr3st4Sh0P)

You can customize the admin credentials by setting the following environment variables before running docker compose:

export ADMIN_MAIL=your-email@example.com
export ADMIN_PASSWD=Your-Secure-Password
docker compose up

Docker will bind your port 8001 to the web server. If you want to use other port, open and modify the file docker-compose.yml. MySQL credentials can also be found and modified in this file if needed.

Note: Before auto-installing PrestaShop, this container checks the file app/config/parameters.php does not exist on startup. If you expect the container to (re)install your shop, remove this file if it exists. And make sure the container user www-data has write access to the whole workspace.

Documentation

For detailed information, see:

🚀 Development Guide - Complete setup and development guide

Documentation

For technical information (core, module and theme development, performance...), head on to PrestaShop DevDocs

If you want to learn how to use PrestaShop 9, read our User documentation.

First-time users will be particularly interested in the following guides:

Getting Started: How to install PrestaShop, and what you need to know.
User Guide: All there is to know to put PrestaShop to good use.
Updating Guide: Switching to the newest version is not trivial. Make sure you do it right.
Merchant's Guide: Tips and tricks for first-time online sellers.
The FAQ page should also be of tremendous help to you.

Contributing

PrestaShop is an Open Source project, and it wouldn't be possible without the help of the hundreds of contributors, who submitted improvements and bugfixes over the years. Thank you all!

If you want to contribute code to PrestaShop, read the CONTRIBUTING.md file in this repository or read the tutorials about contribution on the documentation site.

Don't know where to start? Check the good first issue label to have a look at all beginner-friendly improvements and bug fixes.

If you want to help translate PrestaShop in your language, join us on Crowdin!

If using AI tools to write code, make sure your agent has read the .ai/CONTEXT.md file. You can find more details in our dev doc regarding AI assisted development.

Reporting Issues

Our bugtracker is on GitHub. We encourage you to create detailed issues as soon as you see them.

Read our Contribute by reporting issues guide for details and tips.

Reporting Security Issues

Responsible (and private) disclosure is a standard practice when someone encounters a security problem: before making it public, the discoverer informs the Core team about it, so that a fix can be prepared, and thus minimize the potential damage.

The PrestaShop team tries to be very proactive when preventing security problems. Even so, critical issues might surface without notice.

This is why we have set up a Bug Bounty Program where anyone can privately contact us with all the details about issues that affect the security of PrestaShop merchants or customers. Our security team will answer you, and discuss of a timeframe for your publication of the details.

Understanding a security issue means knowing how the attacker got in and hacked the site. If you have those details, then please do contact us privately about it (and please do not publish those details before we answer). If you do not know how the attacker got in, please ask for help.

Extending PrestaShop

PrestaShop is a very extensible e-commerce platform, both through modules and themes. Developers can even override the default components and behaviors. Learn more about this on the Modules documentation and the Themes documentation.

Community forums

You can discuss about e-commerce, help other merchants and get help, and contribute to improving PrestaShop together with the PrestaShop community on PrestaShop Slack channel, project's discussions on GitHub or on the the PrestaShop forums.

Thank you for downloading and using the PrestaShop Open Source e-commerce solution!

vrana/adminer

Database management in a single PHP file

Adminer

Adminer is a full-featured database management tool written in PHP. It consists of a single file ready to deploy to the target server. Adminer Editor offers data manipulation for end-users.

Official Website

Features

Supports: MySQL, MariaDB, PostgreSQL, CockroachDB, SQLite, MS SQL, Oracle
Plugins for: Elasticsearch, SimpleDB, MongoDB, Redis, Firebird, ClickHouse, IGDB, IMAP
Requirements: PHP 5.3+ (compiled file), PHP 7.4+ (source codes)
Browsers: Any, with full functionality in browsers since April 2018 (requires JavaScript)

Screenshot

Installation

If downloaded from Git then run: git submodule update --init (or composer install)

adminer/index.php - Run development version of Adminer
editor/index.php - Run development version of Adminer Editor
editor/example.php - Example customization
compile.php - Create a single file version
lang.php - Update translations
tests/*.spec.js - Playwright end-to-end tests

Plugins

There are several plugins distributed with Adminer, as well as many user-contributed plugins listed on the Adminer Plugins page.

joomla/joomla-cms

Home of the Joomla! Content Management System

Joomla! CMS™

Build Status

Actions	PHP	Node	npm

Overview

This is the source of Joomla! 5.x.
Joomla's Official website.
Joomla! 5.4 version history.
Detailed changes are in the changelog.

What is Joomla?

Joomla! is a Content Management System (CMS) which enables you to build websites and powerful online applications.
It is a simple and powerful web server application which requires a server with PHP and either MySQL, MariaDB or PostgreSQL to run. You can find full technical requirements here.
Joomla! is free and Open Source software distributed under the GNU General Public License version 2 or later.

Looking for an installable package?

Joomla is not installable out of the box from this repository, please use:

For the latest stable package: https://downloads.joomla.org
For a nightly package: https://developer.joomla.org/nightly-builds.html

How to get a working installation from the source

For detailed instructions please visit https://docs.joomla.org/Special:MyLanguage/J5.x:Setting_Up_Your_Local_Environment

You will need:

PHP - basically the same as you need for running a Joomla Site, but you need the cli (command line interface) Version (see https://docs.joomla.org/Special:MyLanguage/Configuring_a_LAMPP_server_for_PHP_development)
Composer - for managing Joomla's PHP Dependencies. For help installing composer please read the documentation at https://getcomposer.org/doc/00-intro.md
Node.js - for compiling Joomla's Javascript and SASS files. For help installing Node.js please follow the instructions available on https://nodejs.org/en/
Git - for version management. Download from here https://git-scm.com/downloads (MacOS users can also use Brew and Linux users can use the built-in package manager, eg apt, yum, etc).

Steps to setup the local environment:

Clone the repository:

git clone https://github.com/joomla/joomla-cms.git

Go to the joomla-cms folder:

cd joomla-cms

Go to the 5.4-dev branch:

git checkout 5.4-dev

Install all the needed composer packages:

composer install

Install all the needed npm packages:

npm ci

Things to be aware of when pulling: Joomla creates a cache of the namespaces of its extensions in JOOMLA_ROOT/administrator/cache/autoload_psr4.php. If extensions are created, deleted or removed in git then this file needs to be recreated. You can simply delete the file and it will be regenerated on the next call to Joomla.

Do you want to improve Joomla?

Where to request a feature?
How do you report a bug on the Issue Tracker?
How to submit code to the Joomla CMS using a Pull Request?
Get Involved: Joomla! is community developed software. Join the community.
Documentation for Developers.
Documentation for Web designers.
Provide a translation for Joomla: Joomla Crowdin Project

Which branch should my Pull Request target?

Using a simple classification keeps the project stable, transparent, and easy for everyone to contribute.

Type of change	What it means	Target branch
Bug / Patch release	The change fixes an actual error. The software crashes, produces the wrong result, or behaves contrary to its specification. It can be resolved without large‑scale refactoring or new functionality.	5.4-dev (6.1-dev) *
Feature / Minor release	Anything that isn’t a strict bug – new behavior, refactoring, performance improvements, enhancements, UI tweaks, etc. These changes are bundled together for the next minor version.	6.2-dev

* All bugs that already exist in version 5.4.x should be fixed in 5.4-dev. Only bugs that are introduced for the first time in version 6.x should target the 6.1-dev branch.

A member of the maintainer or bug squad team confirms the classification and sets the appropriate labels when a PR is opened. If a PR is opened in the wrong branch, a maintainer will simply ask you to retarget it to the proper branch.

Copyright

(C) 2005 Open Source Matters, Inc. https://www.joomla.org
Distributed under the GNU General Public License version 2 or later
See License details

ChurchCRM/CRM

ChurchCRM - A free and open-source Church Management Software (ChMS) to help churches manage their membership data, groups, events, and finances.

ChurchCRM

🌟 Welcome to ChurchCRM! 🌟

Welcome to ChurchCRM — an open-source church management system. Visit churchcrm.io to learn more.

⛪️ About ChurchCRM

ChurchCRM exists to serve the Church — every congregation, in every country, in every language. We believe that God’s people deserve world-class tools without the burden of licensing fees, vendor lock-in, or data ownership concerns. This software is our ministry: open-source, community-built, freely given.

Whether you’re a developer, designer, tester, or simply passionate about improving church management, there’s a place for you here!

🚀 Get Started

If you're new to ChurchCRM, start with our Documentation. You'll find step-by-step installation instructions, configuration notes, and user guides there.

Quick start: see the "Quick Start" section in the Documentation for a fast setup.

For detailed technical Documentation and developer guides, see our Documentation.

To test the demo, visit our official demo page:

-- Demo: Demo site — NOTE: this is a shared, read-write demo that may be reset regularly and contains only sample data; do not use it for any sensitive or production data.

🌐 Localization Support

One of ChurchCRM's strengths is its commitment to inclusivity. ChurchCRM proudly supports localization in 40+ locales, ensuring accessibility for diverse communities worldwide. Whether you speak English, Spanish, French, or another supported language, you can use ChurchCRM in a familiar way.

Join our localization team on poeditor.com to contribute to your language’s support.

See the latest translation status and audit report: locale/poeditor-audit.md.

💡 How to Contribute

We welcome contributions from everyone! Whether it's bug reports, feature requests, or code contributions, your input is invaluable.

[See the contribution guidelines for how to file issues and submit pull requests.]

Quick contributions: fork the repository, create a feature branch, run the test suite, and open a pull request; see CONTRIBUTING.md for details.

📚 Documentation

Our Documentation is your go-to resource for understanding ChurchCRM. If you notice anything missing or unclear, feel free to open an issue or submit a pull request.

🤝 Community

Join our Discord community to connect with other users, ask questions, and share your experiences. We believe in the power of a supportive community!

🙏 Thank You

A heartfelt thank you to all our contributors, past and present. Your efforts make ChurchCRM better with every release.

Recent Contribution History

Star History

🌐 Stay Connected

Happy coding and community building! 🎉

— The ChurchCRM Team

investbrainapp/investbrain

Smart LLM-enabled investment tracker that consolidates and monitors market performance across your different brokerages

About Investbrain

Investbrain is a smart open-source investment tracker that helps you manage, track, and make informed decisions about your investments.

Under the hood

Investbrain is a Laravel PHP web application that has an extensible market data provider interface. Out of the box, we feature many market data providers. But intrepid developers can create their own providers! We also offer integrations with OpenAI and Ollama for our "chat with your holdings" capability. Finally, of course we have robust support for i18n, a11y, and dark mode.

Self hosting

For ease of installation, we highly recommend installing Investbrain using the provided Docker Compose file, which uses the official Investbrain Docker image and includes all the necessary dependencies to seamlessly build everything you need to get started quickly!

Before getting started, you should already have Docker Engine installed on your machine.

Ready? Let's get started!

1. Download copy of Docker Compose file

Grab a copy of the docker-compose.yml using wget, curl or similar:

curl -O https://raw.githubusercontent.com/investbrainapp/investbrain/main/docker-compose.yml

2. Set your environment

Adjust the environment properties in the compose file to your preferences.

3. Run docker compose up

It might take a few minutes to pull the Docker images. But assuming everything worked as expected, you should now be able to access Investbrain in the browser by visiting:

http://localhost:8000/register

Congrats! You've just installed Investbrain!

Chat with your holdings

Investbrain offers an AI powered chat assistant that is grounded on your investments. This enables you to use AI as a thought partner when making investment decisions.

Most of the major labs are currently supported (OpenAI, Anthropic, Gemini, xAI, etc). You'll need to obtain API keys from your selected provider and configure that in your .env file using the appropriate keys.

Investbrain is also compatible with Ollama (and other OpenAI compatible APIs). If you are self-hosting your own large language models ("LLMs") that exposes an OpenAI compatible API (e.g. Ollama), you'll need to configure your local endpoint in your .env file.

See available options below.

Always keep in mind the limitations of LLMs. When in doubt, consult a licensed investment advisor.

Market data providers

Investbrain includes an extensible market data provider interface that allows you to retrieve stock market data from multiple providers, such as Yahoo Finance, Twelve Data, Finnhub, Alpaca, and Alpha Vantage. The interface includes a built-in fallback mechanism to ensure reliable data access, even if a provider fails.

Market Data Configuration

You can specify the market data provider you want to use in your environment variables:

MARKET_DATA_PROVIDER=yahoo

You can also use Investbrain's built-in fallback mechanism to ensure reliable data access. If any provider fails, Investbrain will automatically attempt to retrieve data from the next available provider, continuing through your configured providers until one returns successfully.

Your selected providers should be listed in your environment variables. Each should be separated by a comma:

MARKET_DATA_PROVIDER=yahoo,alphavantage

In the above example, Yahoo Finance will be attempted first. If Yahoo Finance fails to retrieve market data, the application will automatically try Alpha Vantage.

Custom providers

If you wish to create your own market data provider, you can create your own implementation of the MarketDataInterface. You can refer to any existing market data implementation as an example.

Once you've created your market data implementation, be sure add your custom provider to the Investbrain configuration file, under the interfaces section:


'interfaces' => [
    //                       *  *  *
    'custom_provider' => \App\Services\CustomProviderMarketData::class,
    //                       *  *  *
],

And add your custom provider to your .env file:

MARKET_DATA_PROVIDER=yahoo,alphavantage,custom_provider

Feel free to submit a PR with any custom providers you create.

Import / Export

Investbrain includes a convenient feature which allows you to maintain the portability of your portfolios and transaction data.

Import

Imports are "upserted" to the database. If the record does not already exist in the database, the record will be created. However, when a portfolio or transaction exists (i.e. the record's ID matches an existing record), the record will be updated. This way, you can simultaneously create new records, but also bulk update records.

Export

Exporting your portfolios and transactions is a convenient way to back-up your Investbrain data. It is also a convenient way to maintain portability of your data.

Configuration

There are several optional configurations available when installing using the recommended Docker method. These options are configurable using an environment file. Configurations can be added to your .env file or to the environment property in the docker-compose.yml file.

Option	Description	Default
APP_URL	The URL where your Investbrain installation will be accessible	http://localhost
APP_PORT	The HTTP port exposed by the NGINX container	8000
APP_KEY	Encryption key for various security-related functions	Set automatically during install
MARKET_DATA_PROVIDER	The market data provider to use (either `yahoo`, `twelvedata`, `alphavantage`, `alpaca`, or `finnhub`)	yahoo
ALPHAVANTAGE_API_KEY	If using the Alpha Vantage provider	`null`
FINNHUB_API_KEY	If using the Finnhub provider	`null`
ALPACA_API_KEY	If using the Alpaca provider	`null`
ALPACA_API_SECRET	If using the Alpaca provider	`null`
TWELVEDATA_API_SECRET	If using the Twelve Data provider	`null`
MARKET_DATA_REFRESH	Cadence to refresh market data in minutes	30
APP_TIMEZONE	Timezone for the application, including daily change captures	UTC
AI_CHAT_ENABLED	Whether to enable AI chat features	`false`
CHAT_PROVIDER	Which chat provider to use (one of `openai`, `anthropic`, `gemini`, `azure`, `groq`, `xai`, `deepseek`, `mistral`, `ollama`)	`openai`
CHAT_MODEL	The selected LLM used for AI chat	defaults to current smartest model from lab
ANTHROPIC_API_KEY	If using Anthropic for chat	`null`
OPENAI_API_KEY	If using OpenAI for chat	`null`
OLLAMA_BASE_URL	If using Ollama for chat	`http://localhost:11434`
OLLAMA_API_KEY	May be required if using Ollama for chat	`null`
DAILY_CHANGE_TIME	The time of day to capture daily change	23:00
REGISTRATION_ENABLED	Whether to enable registration of new users	`true`

Note: These options affect the docker-compose.yml file and are cached during run-time. If change any environment configurations, you'll have to restart the container before your changes take effect.

Updating

To update Investbrain using the recommended Docker installation method, you just need to stop the running containers:

docker compose stop

Then pull the latest Docker image:

docker image pull investbrainapp/investbrain:latest

Finally bring the containers back up!

docker compose up

Easy as that!

Command line utilities

Investbrain comes bundled with several helpful command line utilities to make managing your portfolios and holdings more efficient. Keep in mind these commands are extremely powerful and can make irreversable changes to your holdings. Just to be safe, we recommend backing up your portfolios before using these commands.

To run these commands, you can use docker exec like this:

docker exec -it investbrain-app php artisan <replace with command you want to run>

If you need more details on what the command does, you can take a look at the options available using the help option:

<command you want to run> --help

Command	Description
refresh:market-data	Refreshes market data with your configured market data provider.
refresh:dividend-data	Refreshes dividend data with your configured market data provider. Will also re-calculate your total dividends earned for each holding.
refresh:split-data	Refreshes splits data with your configured market data provider. Will also create new transactions to account for any splits.
refresh:currency-data	Grabs the latest daily currency exchange rate data and persists to the database.
capture:daily-change	Captures a snapshot of each portfolio's daily performance.
sync:daily-change	Syncs daily snapshots of your portfolio's daily performance. Useful to fill in gaps in your portfolio charts. (Note: this is an extremely resource intensive query.)
sync:holdings	Syncs performance of holdings with related transactions (i.e. dividends, realized gains, etc).
fix:cost-basis-for-sales	Utility to automatically re-calculates cost basis for sale transactions.

Troubleshooting

If you are facing issues with Investbrain, it can be handy to monitor the application's logs:

docker exec -it investbrain-app cat storage/logs/laravel.log

or you can live monitor logs using tail:

docker exec -it investbrain-app tail -f storage/logs/laravel.log

Common issues

Application styling is broken and images are too big

If you're serving Investbrain from a DNS name (e.g. example.com), it's likely that you haven't updated the ASSET_URL environment yet. The URL provided there will be used to generate absolute URLs for images, JS, and CSS assets on the front end of the application.

Market data not refreshing on fresh install

If you're unable to refresh market data out of the box (i.e. your market data provider is set to Yahoo), there is a chance Yahoo is being blocked by a firewall or adblocker. Pihole is known to block fc.yahoo.com which is the domain used to query Yahoo.

Once you whitelist fc.yahoo.com in pihole, your market data should begin populating!

Testing

Investbrain has a robus PHPUnit test suite that creates an in-memory SQLite database and runs any queued jobs synchronously using Laravel's array driver. You can run the entire Investbrain test suite from within the Docker container by running:

docker exec -it investbrain-app php artisan test

Contributing

We appreciate any contributions to Investbrain! Please open a pull request on our Github repository. Here are some ideas for first time contributors:

Improve our documentation
Create new market data providers
Enhance the user interface
Additional translations
Fix bugs

When you submit a contribution, don't forget to include passing tests with your PR!

Code of Conduct

We ask that you be kind and polite when interacting with the Investbrain community.

Security Vulnerabilities

If you discover a security vulnerability within Investbrain, please submit your report via Github. All security vulnerabilities will be promptly addressed. We ask that you keep any suspected vulnerabilities private and confidential until they have been appropriately addressed.

License

Investbrain is open-sourced software licensed under the CC-BY-NC 4.0.

aonez/Keka

The macOS & iOS file archiver

Keka

The macOS file archiver.

With Keka you can compress as many files as you want in a bunch of formats. You can also encrypt them to store and share securely and with privacy.

Downloads

Current version

Go to the Keka website at https://www.keka.io to get the latest version.

Also you can check the history of releases in the Releases section.

Legacy versions

You will find the updated list of legacy versions in the Keka website at https://www.keka.io/#legacy

What more to do here

Issues - look for open ones, create a new one.
Wiki - learn and share Keka knowledge.
Discussions - chat about Keka with others and share your ideas.
Releases - download a specific version.
Translations - keep Keka multilingual and well spoken 😃

This repository is used mainly to take care of Issues and have a collaborative Wiki.

If you have a problem or a request just search the Issues for similar ones or create a new one.

If you'll like to chat and you think the Issues section is not the right place, just head to the Discussions section.

Also head to Releases if you need a specific version not found on the Keka website.

laravel/boost

Laravel-focused MCP server for augmenting your AI powered local development experience.

Introduction

Laravel Boost accelerates AI-assisted development by providing the essential context and structure that AI needs to generate high-quality, Laravel-specific code.

Official Documentation

Documentation for Laravel Boost can be found on the Laravel website.

Contributing

Thank you for considering contributing to Boost! The contribution guide can be found in the Laravel documentation.

Code of Conduct

In order to ensure that the Laravel community is welcoming to all, please review and abide by the Code of Conduct.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

License

Laravel Boost is open-sourced software licensed under the MIT license.

sebastianbergmann/phpunit

The PHP Unit Testing framework.

PHPUnit

PHPUnit is a programmer-oriented testing framework for PHP. It is an instance of the xUnit architecture for unit testing frameworks.

Installation

We distribute a PHP Archive (PHAR) that has all required dependencies of PHPUnit bundled in a single file:

$ wget https://phar.phpunit.de/phpunit-X.Y.phar

$ php phpunit-X.Y.phar --version

Please replace X.Y with the version of PHPUnit you are interested in.

Alternatively, you may use Composer to download and install PHPUnit as well as its dependencies. Please refer to the documentation for details on how to install PHPUnit.

Contribute

Please refer to CONTRIBUTING.md for information on how to contribute to PHPUnit and its related projects.

A big "Thank you!" to everyone who has contributed to PHPUnit! You can find a detailed list of contributors on every PHPUnit related package on GitHub.

Here is a list of all components that are primarily developed and maintained by Sebastian Bergmann:

A very special thanks to everyone who has contributed to the PHPUnit Manual.

In addition to the components listed above, PHPUnit depends on the components listed below:

These tools are used to develop PHPUnit:

Sponsors

It has taken Sebastian Bergmann thousands of hours to develop, test, and support PHPUnit. You can sponsor his Open Source work through GitHub Sponsors, for example.

These businesses support Sebastian Bergmann's work on PHPUnit:

Would you like to see your logo here as well as on the PHPUnit website? Contact Sebastian Bergmann at sponsoring@phpunit.de to learn more about how you can support his work on PHPUnit.

Whether you are a CEO, CFO, CTO, or a developer: your company surely depends on Open Source software. It is time to pay your share and support maintainers like Sebastian Bergmann.

Cacti/cacti

Cacti ™

Cacti

Overview

Cacti is an open-source network monitoring and graphing platform built on RRDtool.

It provides a scalable framework to collect, store, and visualize time-series data from network devices, servers, and applications.

Core capabilities include:

Automated device discovery
Local and remote data collection
Graph, data source, and RRA templating
SNMP polling (v1/v2/v3) and IPv6 support
Role-based access control (RBAC)
Plugin framework
Dynamic graph viewing and export options

Release Branches

Cacti maintains two primary branches:

Branch	Purpose
`1.2.x`	Stable long-lived release series
`develop`	Active development toward Cacti 1.3.x

For the latest published version, see GitHub Releases.

System Requirements

Minimum supported dependencies by branch:

Dependency	Cacti `1.2.x`	Cacti `develop` (1.3.x)
MariaDB	5.6+	10.2.x+
MySQL	5.6+	8.0+
PHP	8.1+	8.1+
RRDtool	1.4+	1.8+
Net-SNMP	5.5+	5.8+

Notes:

RRDtool 1.9+ is recommended for newer dynamic graph features in 1.3.x.
Net-SNMP 5.9+ is recommended for broader SNMPv3 protocol coverage.
A web server with PHP support is required.
PHP should be available as CLI or CGI for scheduled polling and maintenance scripts.
php-snmp is optional; validate behavior carefully if you depend on IPv6 and SNMPv3.
To force the Net-SNMP binaries while php-snmp remains installed, set $php_snmp_support = false; in include/config.php.

Operating system guidance:

1.2.x: RHEL/Rocky/Alma 8+ (or equivalent) is a common baseline.
1.3.x: RHEL/Rocky/Alma 9+ or CentOS Stream 9+ is preferred for modern PHP packaging.
Debian and Ubuntu are also well supported.

Installation (Source Checkout)

Clone the repository:

git clone https://github.com/Cacti/cacti.git
cd cacti

Dependency management:

For a source checkout on both 1.2.x and develop, install dependencies with Composer.
Use composer update only when intentionally refreshing dependency versions.

Install dependencies:

composer install

Windows users may need:

composer install --ignore-platform-req=ext-pcntl --ignore-platform-req=ext-posix

Then configure your database and web server, and complete setup using the official docs:

https://github.com/Cacti/documentation

Database Upgrades and Schema Checks

When running from source (especially develop), schema updates may be required after pulling changes.

Upgrade the database schema:

sudo -u cacti php -q cli/upgrade_database.php --forcever=`cat include/cacti_version`

If needed, force a re-upgrade from an earlier version:

php -q cli/upgrade_database.php --forcever=<older_version>

Audit schema consistency:

php cli/audit_database.php --report

Data Collection and Polling

Cacti collects data through data sources, which can use:

SNMP
Scripts
Command output
Databases
Custom input methods

Polling engines:

Poller	Description
PHP Poller	Built-in polling engine
Spine	High-performance C-based poller

Spine supports SNMPv1/v2 and SNMPv3 with IPv6, with some advanced protocol support depending on how Net-SNMP is compiled on your platform.

Features

Device discovery and automation workflows
Reusable templates for graphs and data sources
Distributed remote data collectors
Plugin architecture for extensibility
Dynamic graph interactions (time navigation, realtime view, CSV export)
Fine-grained user and group permissions using RBAC
Broad RRDtool graphing support (including VDEFs and stacked lines)

Documentation

Official documentation is maintained in a separate repository:

https://github.com/Cacti/documentation

Contributing

Contributions are welcome.

Fork this repository.
Create a branch for your change.
Submit a pull request.

You can also help improve docs in:

https://github.com/Cacti/documentation

Community

Community support is available on the Cacti forums:

https://forums.cacti.net

Contributors

Thanks go to these wonderful people (emoji key):

_{Ian Berry} 💻🛡️📖🎨	_{Reinhard Scheck} 💻🛡️📖	_{Tony Roman} 💻🛡️📖🌍⚠️🎨	_{Andy Blyler} 💻	_{Larry Adams} 💻🛡️📖🚇🌍⚠️🎨🚧👀	_{Mark Brugnoli-Vinten} 💻🛡️📖🚇🌍⚠️🎨🚧👀	_{Jimmy Conner} 💻🛡️📖🚇🌍⚠️🎨🚧👀
_{Petr Macek} 💻🛡️📖👀	_{Andreas Braun} 💻📖🌍🎨👀	_{Jing Chen} 💻🛡️📖👀	_{Thomas Vincent} 💻🛡️📖🚇🌍⚠️🚧👀	_{Sean Mancini} 💻📖🚇⚠️👀	_{J.P. Pasnak, CD} 💻🛡️📖🌍⚠️	_{Chris Bell} 💻
_{Paul Gevers} 💻📖🌍⚠️	_{Morten Stevens} 💻	_iankberry 💻	_ronytomen 💻👀	_reboot1983 💻👀	_micke2k 💻🎨	_{EkaterinePapava} 💻🌍
_hljtql 💻🌍	_yeager 💻	_YongBoLiu 💻👀	_arjanoosting 💻	_Coool 💻🌍	_kim-fitness 💻👀	_earendilfr 💻📖
_purplegrape 💻🌍	_Сергей 💻🌍	_DavidLiedke 💻🛡️📖🌍	_MSS970 💻👀	_{SjonHortensius} 💻	_thurban 💻👀	_riversdev0 💻👀
_chilek 💻👀	_MarcBanyard 💻	_bernisys 💻	_ka1lie 💻	_Dmitry 💻🌍	_sysres-dev 💻👀	_rb83 💻👀
_click0 💻	_smiles1969 💻	_gadzet21 💻	_rlaager 💻	_paulcalabro 💻	_mhoran 💻👀	_Javier 💻📖🌍
_frontierliu 💻👀	_xbolshe 💻	_arno-st 💻	_c72578 💻	_C00kiekiller 💻	_nuno-silva 💻	_pautiina 💻👀
_interduo 💻🌍	_seanmancini 💻⚠️	_jav4 💻	_fabriciotm 💻	_eriksejr 💻	_hb9xar 💻	_nightflyza 💻
_nbz6 💻	_iaohkut 💻	_{Nakayama Kito} 💻🌍	_SMark-Black 💻	_Givo29 💻	_GregOriol 💻	_gvde 💻👀
_dallenk 💻👀	_dvzrv 💻	_ctrowat 💻	_Beuc 💻🛡️	_panlinux 💻	_begemoti 💻	_dsclassen 💻
_scline 💻	_sky93 💻	_SergioChan 💻	_ShaunR 💻	_{sebastienwarin} 💻	_tbriceno-hub 💻	_tyearke 💻
_{Vladyslav78956785786576} 💻	_aliuzzz 💻	_UnAfraid 💻	_robwdwd 💻	_Poslik 💻	_Xake 💻	_Cosmologist 💻
_PVi1 💻	_OhWelp 💻	_{TheNetworkIsDown} 💻	_tersmitten 💻	_F-i-f 💻	_terrellgf 💻⚠️	_surfermarty 💻
_aqr199 💻	_snsupersharp 💻🌍	_skyjou 💻	_{skeletorgithub} 💻	_richud 💻	_oshiewan 💻	_oderturm 💻
_stevenseeley 💻	_mcnc-clovett 💻	_m8522s 💻	_linusat 💻	_kruegerj 💻	_kotso 💻	_jsgh 💻
_jkbzh 💻📖	_itaxer 💻	_dwpaulx 💻	_ahouston 💻	_xavloose 💻	_evansa 💻	_{eduardomozart} 💻
_{edewillians10} 💻	_dimaslv 💻👀	_simfishing 💻	_duhow 💻	_dschall 💻	_dschultzca 💻	_kripper 💻
_3bars 💻	_kornrunner 💻	_carryel 💻	_dabeani 💻	_xubowin 💻	_barreljan 💻👀	_{athos-ribeiro} 💻
_apinheiro 💻	_sashashura 💻	_A200K 💻	_k0pak4 💻	_TheBlueMatt 💻	_mchorsley 💻👀	_luismrsilva 💻
_daniel-lucio 💻	_Luhrel 💻	_stslayer1 💻	_KrisShannon 💻	_devsibwarra 💻👀	_{kersten-lohmeyer} 💻	_{Harry-Junhua-Huang} 💻
_jsoref 💻⚠️👀	_JonBogan 💻📖	_jayaich 💻	_jab60 💻	_jkrinke 💻	_JamesTilt 💻	_neclimdul 💻
_hmorandell 💻	_gdsotirov 💻	_inode64 💻	_00gh 👀	_Dmitrii 👀	_Patrick 💻🛡️📖🌍	_{Daniel Nylander} 💻🌍
_{Anton Zhuravlev} 💻🌍	_{John Horne} 💻🌍	_{Vladyslav V. Prodan} 💻🌍	_{Ronny Preiss} 💻🌍	_{Rostyslav Haitkulov} 💻🌍	_{Nicolas BUTIN} 💻🌍	_olafhering 💻
_Mojo-OG 💻	_abdulm5 💻

This project follows the all-contributors specification. Contributions of any kind are welcome.

License

Cacti is licensed under the GNU General Public License v2.0.

See LICENSE for details.

cedar2025/Xboard

High-performance panel based on V2board secondary development supporting new protocols and new features

Xboard

📖 Introduction

Xboard is a modern panel system built on Laravel 11, focusing on providing a clean and efficient user experience.

✨ Features

🚀 Built with Laravel 12 + Octane for significant performance gains
🎨 Redesigned admin interface (React + Shadcn UI)
📱 Modern user frontend (Vue3 + TypeScript)
🐳 Ready-to-use Docker deployment solution
🎯 Optimized system architecture for better maintainability

🚀 Quick Start

git clone -b compose --depth 1 https://github.com/cedar2025/Xboard && \
cd Xboard && \
docker compose run -it --rm \
    -e ENABLE_SQLITE=true \
    -e ENABLE_REDIS=true \
    -e ADMIN_ACCOUNT=admin@demo.com \
    xboard php artisan xboard:install && \
docker compose up -d

After installation, visit: http://SERVER_IP:7001
⚠️ Make sure to save the admin credentials shown during installation

📖 Documentation

🔄 Upgrade Notice

🚨 Important: This version involves significant changes. Please strictly follow the upgrade documentation and backup your database before upgrading. Note that upgrading and migration are different processes, do not confuse them.

Development Guides

Plugin Development Guide - Complete guide for developing XBoard plugins

Deployment Guides

Deploy with 1Panel
Deploy with Docker Compose
Deploy with aaPanel
Deploy with aaPanel + Docker (Recommended)

Migration Guides

🛠️ Tech Stack

Backend: Laravel 11 + Octane
Admin Panel: React + Shadcn UI + TailwindCSS
User Frontend: Vue3 + TypeScript + NaiveUI
Deployment: Docker + Docker Compose
Caching: Redis + Octane Cache

📷 Preview

⚠️ Disclaimer

This project is for learning and communication purposes only. Users are responsible for any consequences of using this project.

❤️ Support The Project

If this project has helped you, donations are appreciated. They help support ongoing maintenance and would make me very happy.

TRC20: TLypStEWsVrj6Wz9mCxbXffqgt5yz3Y4XB

🌟 Maintenance Notice

This project is currently under light maintenance. We will:

Fix critical bugs and security issues
Review and merge important pull requests
Provide necessary updates for compatibility

However, new feature development may be limited.

🔔 Important Notes

Restart required after modifying admin path:

docker compose restart

For aaPanel installations, restart the Octane daemon process

🤝 Contributing

Issues and Pull Requests are welcome to help improve the project.

📈 Star History

espocrm/espocrm

EspoCRM – Open Source CRM Application

EspoCRM

EspoCRM is a free, open-source CRM platform designed to help organizations build and maintain strong customer relationships. It provides a wide range of tools to store, organize, and manage leads, contacts, sales opportunities, marketing campaigns, support cases, and more – all business information in a simple and intuitive interface.

Architecture

EspoCRM is a web application with a frontend designed as a single-page application and a REST API backend written in PHP.

Demo

You can try the CRM on an online demo.

Requirements

PHP 8.3 - 8.5;
MySQL 8.0 (and later), or MariaDB 10.3 (and later);
PostgreSQL 15 (and later).

For more information about server configuration, see this article.

Download

Download the latest release from our website or from GitHub releases.

Release notes

Release notes are available at GitHub releases.

Documentation

See the documentation for administrators, users and developers.

Why EspoCRM?

Open-source transparency. EspoCRM's source code is open and accessible, so anyone can inspect it and see how data is being managed within the CRM.
Customization freedom. You can develop features, create custom entities, fields, relationships, buttons to make the system fit your specific needs. EspoCRM is more than a CRM – it's a platform for building custom business applications.
Clean user interface. EspoCRM offers an uncluttered, minimalist, and fast user interface, which is easy to navigate and has a short learning curve.
Straightforward REST API. It can be easily integrated with other applications using a REST API.

Who is EspoCRM for?

From startups, small & medium-sized businesses to larger organizations. A flexible, fully customizable solution that scales with your needs.
Developers & tech enthusiasts. You can extend functionalities, build extensions, and create custom integrations.
Anyone seeking a free or on-premise CRM.

Installing stable version

See installation instructions:

Bug reporting

Create a GitHub issue or post on our forum.

Development

See the developer documentation.

We highly recommend using an IDE for development. The backend codebase adheres to SOLID principles, utilizes interfaces, static typing and generics. We recommend to start learning EspoCRM from the Dependency Injection article in the documentation.

Metadata plays an integral role in the EspoCRM application. All possible parameters are described with a JSON Schema, meaning you will have autocompletion in the IDE. You can also find the full metadata reference in the documentation.

The frontend is an SPA built on a custom framework. It utilizes nested views and service DI, with the core partially written in TypeScript. Developers primarily work with existing form and field view implementations.

Community & Support

If you have a question regarding some features, need help or customizations, want to get in touch with other EspoCRM users, or add a feature request, please use our community forum. We believe that using the forum to ask for help and share experience allows everyone in the community to contribute and use this knowledge later.

License

EspoCRM is an open-source project licensed under GNU AGPLv3.

Contributing

Before we can merge your pull request, you need to accept our CLA here. See the contributing guidelines.

Branches:

fix – upcoming maintenance release; minor fixes should be pushed to this branch;
master – develop branch; new features should be pushed to this branch;
stable – last stable release.

Language

If you want to improve existing translation or add a language that is not available yet, you can contribute on our POEditor project. See instructions here. It may be reasonable to let us know about your intention to join the POEditor project by posting on our forum or via the contact form on our website.

Changes on POEditor are usually merged to the GitHub repository before minor releases.

monicahq/monica

Personal CRM. Remember everything about your friends, family and business relationships.

Document your life

Docs - Bug report

Monica is an open source personal relationship management system, that lets you document your life.

Warning

This branch is in development. It’s our beta version.

If you want to browse the stable and current version, see the 4.x branch.

Introduction

Monica is an open-source web application that enables you to document your life, organize, and log your interactions with your family and friends. We call it a PRM, or Personal Relationship Management. Imagine a CRM—a commonly used tool by sales teams in the corporate world—for your friends and family.

Features

Add and manage contacts
Define relationships between contacts
Reminders
Automatic reminders for birthdays
Ability to add notes to a contact
Ability to record how you met someone
Management of activities with a contact
Management of tasks
Management of addresses and all the different ways to contact someone
Management of contact field types
Management of a contact’s pets
Top of the art diary to keep track of what’s happening in your life
Ability to record how your day went
Upload documents and photos
Ability to define custom genders
Ability to define custom activity types
Ability to favorite contacts
Multiple vaults and users
Labels to organize contacts
Ability to define what section should appear on the contact sheet
Multiple currencies
Translated in 27 languages

Who is it for?

This project is for people who want to document their lives and those who have difficulty remembering details about the lives of people they care about.

We’ve also had a lot of positive reviews from people with Asperger syndrome, Alzheimer’s disease, and introverts who use our app every day.

What Monica isn’t

Monica is not a social network and it never will be. It’s not meant to be social. It’s designed to be the opposite: it’s for your eyes only.
Monica is not a smart assistant. It won’t guess what you want to do. It’s actually pretty dumb: it will only send you emails for the things you asked to be reminded of.
Monica does not have built-in AI with integrations like ChatGPT.
Monica is not a tool that will scan your data and do nasty things with it. It’s your data, your server, do whatever you want with it. You’re in control of your data.

Contribute

Do you want to lend a hand? That’s great! We accept contributions from everyone, regardless of form.

Here are some of the things you can do to help.

Contribute as a community

Unlike Fight Club, the best way to help is to actually talk about Monica as much as you can in blog posts and articles, or on social media.
You can answer questions in the issue tracker to help other community members.
You can financially support Monica’s development on Patreon or by subscribing to a paid account.

Contribute as a developer

Read our Contribution Guide.
Install the developer version locally so you can start contributing.
Look for issues labelled ‘Bugs’ if you are looking to have an immediate impact on Monica.
Look for issues labelled ‘Help Wanted’. These are issues that you can solve relatively easily.
Look for issues labelled ’Good First Issue’. These issues are for people who want to contribute, but try to work on a small feature first.
If you are an advanced developer, you can try to tackle issues labelled ‘Feature Requests’. These are harder to do and will require a lot of back-and-forth with the repository administrator to make sure we are going to the right direction with the product.

Principles, vision, goals and strategy

We want to use technology in a way that does not harm human relationships, unlike big social networks.

Principles

Monica has a few principles.

It should help improve relationships.
It should be simple to use, simple to contribute to, simple to understand, extremely simple to maintain.
It is not a social network and never will be.
It is not and never will be ad-supported.
Users are not and never will be tracked.
It should be transparent.
It should be open-source.
It should do one thing (documenting your life) extremely well, and nothing more.
It should be well documented.

Vision

Monica’s vision is to help people have more meaningful relationships.

Goals

We want to provide a platform that is:

really easy to use: we value simplicity over anything else.
open-source: we believe everyone should be able to contribute to this tool, and see for themselves that nothing nasty is done behind the scenes that would go against the best interests of the users. We also want to leverage the community to build attractive features and do things that would not be possible otherwise.
easy to contribute to: we want to keep the codebase as simple as possible. This has two big advantages: anyone can contribute, and it’s easily maintainable on the long run.
available everywhere: Monica should be able to run on any desktop OS or mobile phone easily. This will be made possible by making sure the tool is easily installable by anyone who wants to either contribute or host the platform themselves.

Why Open Source?

Why is Monica open source? Is it risky? Could someone steal my code and use it to start a for-profit business that could hurt my own? Why reveal our strategy to the world? We’ve already received these kinds of questions in our emails.

The answer is simple: yes, you can fork Monica and create a competing project, make money from it (even if the license is not ideal for that) and we won’t be aware. But that’s okay, we don’t mind.

We wanted to open source Monica for several reasons:

We believe that this tool can really change people’s lives. We aim to make money from this project, but also want everyone to benefit. Open sourcing it will help Monica become much bigger than we imagine. We believe the software should follow our vision, but we must be humble enough to recognize that ideas come from everywhere and people may have better ideas than us.
You can’t make something great alone. While Monica could become a company and hire a bunch of super smart people to work on it, you can’t beat the manpower of an entire community. Open sourcing the product means bugs will be fixed faster, features will be developed faster, and more importantly, developers will be able to contribute to a tool that positively changes their own lives and the lives of other people.
Doing things in a transparent way leads to formidable things. People respect the project more when they can see how it’s being worked on. You can’t hide nasty things in the code. You can’t do things behind the backs of your users. Doing everything in the open is a major driving force that motivates you to keep doing what’s right.
Once you’ve created a community of passionate developers around your project, you’ve won. Developers are powerful influencers: they create apps, discuss your product on forums, and share it with their networks. Nurture your relationship with developers – users will follow.

Patreon

You can support the development of Monica on Patreon. Thanks for your help.

Contact

Team

Our team is made of two core members:

We are also fortunate to have an amazing community of developers who help us greatly.

Thank you, open source

Monica makes use of numerous open-source projects and we are deeply grateful. We hope that by offering Monica as a free, open-source project, we can help others in the same way these programs have helped us.

License

Licensed under the AGPL License.

FOSSBilling/FOSSBilling

Empower your hosting business with FOSSBilling, the free and open-source solution for efficient billing and client management.

Note

FOSSBilling is under active development and currently considered beta. Expect rough edges and limited support.

FOSSBilling is a free, open-source billing and client management system. It helps online service businesses automate invoicing, payments, and client communication. While it’s popular with web hosting providers, it also works well for software licensing, digital downloads, and subscription services.

Features

Billing & Invoicing: automated invoices, reminders, and basic reporting.
Client Management: a central place for client data and communication.
Extensibility: extension-friendly architecture for integrations and custom features.
Payments: support for multiple gateways.
Translations: community-powered, multi-language interface.
Responsive UI: usable on desktop and mobile.
Security-focused: built with security best practices in mind.

Getting Started

Requirements

FOSSBilling runs on standard LAMP/LEMP stacks. For the latest system requirements (PHP version, extensions, database, etc.), see the official requirements.

Installation

Follow the step-by-step Getting Started guide.

Just exploring? Try the public demo.

Contributing

We welcome contributions from the community! We’re actively modernizing the codebase and there’s plenty to do.

Read the contributor guide.
Pick an item from the open issues.
Open a PR when you’re ready.

If you prefer to start a conversation first, drop by the forum or say hello on Discord.

Star History

Not a developer? Starring the repository helps others discover the project.

License

FOSSBilling is released under the Apache 2.0 license. See LICENSE for details.

Dolibarr/dolibarr

Dolibarr ERP CRM is a modern software package to manage your company or foundation's activity (contacts, suppliers, invoices, orders, stocks, agenda, accounting, ...). it's an open source Web application (written in PHP) designed for businesses of any sizes, foundations and freelancers.

DOLIBARR ERP & CRM

Dolibarr ERP & CRM is a modern software package that helps manage your organization's activities (contacts, quotes, invoices, orders, stocks, agenda, human resources, ecm, manufacturing…).

It's an Open-Source Software suite (written in PHP with JavaScript enhancements) designed for small, medium or large companies, foundations and freelancers.

You can freely use, study, modify or distribute it according to its license.

You can use it as a standalone application or as a web application to access it from the Internet or from a LAN.

Dolibarr has a large community ready to help you, free forums and preferred partners ready to offer commercial support should you need it

LICENSE

Dolibarr is released under the terms of the GNU General Public License as published by the Free Software Foundation; either Version 3 of the License, or (at your option) any later version (GPL-3+).

See the COPYING file for a full copy of the license.

Other licenses apply for some included dependencies. See COPYRIGHT for a full list.

INSTALLING

There is a lot of different solutions to install Dolibarr.

Using packages

If you have low technical skills and you're looking to install Dolibarr ERP/CRM with just few clicks, you can use one of the packaged versions (see next chapter if you have IT knowledge) :

DoliWamp for Windows
DoliDeb for Debian, Ubuntu
DoliRpm for Red Hat, Fedora, OpenSuse, Mandriva or Mageia
The Docker image (see chapter "Using Docker")

Releases can be downloaded from official website.

Using the generic step by step setup (recommended for IT users)

You can use any web server supporting PHP (Apache, Nginx, ...) and a supported database (MariaDB, MySQL or PostgreSQL) to install the standard version:

Verify that your installed PHP version is supported see PHP support.
Uncompress the downloaded .zip archive to copy the dolibarr/htdocs directory and all its files inside your web server root or get the files directly from GitHub (recommended if you know git as it makes it easier if you want to upgrade later):

git clone https://github.com/dolibarr/dolibarr -b x.y (where x.y is the main version like 9.0, 19.0, ...)
Set up your web server to use dolibarr/htdocs as root if your web server does not already define a directory to point to.
Create an empty htdocs/conf/conf.php file and set write permissions for your web server user (write permission will be removed once install is finished)
From your browser, go to the dolibarr "install/" page

The URL will depend on how your web configuration directs to your dolibarr installation. It may look like:

http://localhost/dolibarr/htdocs/install/

or

http://localhost/dolibarr/install/

or

http://yourdolibarrvirtualhost/install/
Follow the installer instructions

Using Docker images

Dolibarr is also available as a Docker image. Installation instructions are available here.

Using ready to use SaaS/Cloud offers

If you lack the time to install it yourself, consider exploring commercial 'ready-to-use' Cloud offerings (refer to https://saas.dolibarr.org). Keep in mind that this third option comes with associated costs.

UPGRADING

Dolibarr supports upgrading, usually without the need for any (commercial) support (depending on if you use any commercial extensions). It supports upgrading all the way from any version after 2.8 without breakage. This is unique in the ERP ecosystem and a benefit our users highly appreciate!

Follow these step-by-step instructions to seamlessly upgrade Dolibarr to the latest version:

At first make a backup of your Dolibarr files & then see
Verify that your installed PHP version is supported by the new version see PHP support.
Overwrite all old files from the 'dolibarr' directory with files provided in the new version's package.
At your next access, Dolibarr will redirect you to the "install/" page to follow the upgrade process. If an install.lock file exists to lock any other upgrade process, the application will ask you to remove the file manually (you should find the install.lock file in the directory used to store generated and uploaded documents, in most cases, it is the directory called "documents").

WHAT'S NEW

See the ChangeLog file.

FEATURES

Main application/modules (all optional)

Third-Parties Management: Customers, Prospects (Leads) and/or Suppliers + Contacts
Members/Membership/Foundation management

Product Management

Products and/or Services catalogue
Stock / Warehouse management + Inventory
Barcodes
Batches / Lots / Serials
Product Variants
Bill of Materials (BOM)
Manufacturing Orders (MO)
Workstations / Workplaces

Customer/Sales Management

Customers/Prospects + Contacts management
Opportunities or Leads management
Commercial proposals management (online signing)
Customer Orders management
Contracts/Subscription management
Interventions management
Ticket System (+ Knowledge management)
Partnership management
Shipping management
Customer Invoices/Credit notes and payment management
Point of Sale (POS)

Supplier/Purchase Management

Suppliers/Vendors + Contacts
Supplier (pricing) requests
Purchase Orders management
Delivery/Reception
Supplier Invoices/Credit notes and payment management
INCOTERMS

Finance/Accounting

Invoices/Payments
Bank accounts management
Direct debit and Credit transfer management (European SEPA)
Accounting management
Donations management
Loan management
Margins
Reports

Collaboration

Shared calendar/agenda (with ical and vcal import/export for third-party tools integration)
Projects & Tasks management
Event organization
Ticket System
Surveys

HR - Human Resources Management

Employee leave management
Expense reports
Recruitment management
Employee/staff management
Timesheets

Other application/modules

Electronic Document Management (EDM)
Bookmarks
Reporting
Data export/import
Barcodes
LDAP connectivity
Click-To-Dial integration
Mass emailing
RSS integration
Social platforms linking
Payment platforms integration (PayPal, Stripe, Paybox...)
Email-Collector
AI support via API

(around 100 modules available by default, 1000+ addons at the official marketplace Dolistore.com)

Other general features

Multi-Language Support (Localization in most major languages)
Multi-users and groups with finely-grained rights
Multi-Currency
Multi-Company (by adding an external module)
Very user-friendly and easy to use
Customizable dashboards
Highly customizable: enable only the modules you need, add user personalized fields, choose your skin, several menu managers (can be used by internal users as a back-office with a particular menu, or by external users as a front-office with another one)
APIs (REST, SOAP)
Code that is easy to understand, maintain and develop (PHP with no heavy framework; trigger and hook architecture)
Support a lot of country-specific features:
- Spanish Tax RE and IRPF
- French NPR VAT rate (VAT called "Non Perçue Récupérable" for DOM-TOM)
- Canadian double taxes (federal/province) and other countries using cumulative VAT
- Tunisian tax stamp
- Argentina invoice numbering using A,B,C...
- Greece fetch customer vat details from AADE, all invoice types, MyData(external free module)
- ZATCA e-invoicing QR-Code
- Compatible with European directives (2006/112/CE ... 2010/45/UE)
- Compatible with data privacy rules (Europe's GDPR, ...)
- ...
Flexible PDF & ODT generation for invoices, proposals, orders...
...

System Environment / Requirements

PHP
MariaDB, MySQL or PostgreSQL
Compatible with all Cloud solutions that match PHP & MySQL or PostgreSQL prerequisites.

See exact requirements on the Wiki

Extending

Dolibarr can be extended with a lot of other external applications or modules from third-party developers available at the DoliStore.

WHAT DOLIBARR CAN'T DO YET

These are features that Dolibarr does not yet fully support:

Tasks dependencies in projects
Payroll module
Native embedded Webmail, but you can send email to contacts in Dolibarr with e.g. offers, invoices, etc.
Dolibarr can't do coffee (yet)

DOCUMENTATION

Administrator, user, developer and translator's documentation are available along with other community resources in the Wiki.

CONTRIBUTING AND RELEASE PROCESS

This project exists thanks to all the people who contribute. Please read the instructions on how to contribute (report a bug/error, a feature request, send code, ...) [Contributing]

A View on Contributors:

The release process is described into the file dev/build/makepack-howto.md

CREDITS

Dolibarr is the work of many contributors over the years and uses some fine PHP libraries.

See COPYRIGHT file.

NEWS AND SOCIAL NETWORKS

Follow Dolibarr project on:

Sponsors

Support this project by becoming a sponsor. Your logo will show up here. 🙏 [Become a sponsor/backer]

firefly-iii/firefly-iii

Firefly III: a personal finances manager

Firefly III

A free and open source personal finance manager
Explore the documentation

View the demo · Report a bug · Request a feature · Ask questions

Billionaires and fascists are breaking democracies and international alliances. Their profits are costing us our safety. (Digital) sovereignty is more important than ever. Firefly III is free open source software and originates from, and lives in the European Union (🇳🇱).

About Firefly III

"Firefly III" is a (self-hosted) manager for your personal finances. It can help you keep track of your expenses and income, so you can spend less and save more. Firefly III supports the use of budgets, categories and tags. Using a bunch of external tools, you can import data. It also has many neat financial reports available.

Firefly III should give you insight into and control over your finances. Money should be useful, not scary. You should be able to see where it is going, to feel your expenses and to... wow, I'm going overboard with this aren't I?

But you get the idea: this is your money. These are your expenses. Stop them from controlling you. I built this tool because I started to dislike money. Having money, not having money, paying bills with money, you get the idea. But no more. I want to feel "safe", whatever my balance is. And I hope this tool can help you. I know it helps me.

Purpose

Personal financial management is pretty difficult, and everybody has their own approach to it. Some people make budgets, other people limit their cashflow by throwing away their credit cards, others try to increase their current cashflow. There are tons of ways to save and earn money. Firefly III works on the principle that if you know where your money is going, you can stop it from going there.

By keeping track of your expenses and your income you can budget accordingly and save money. Stop living from paycheck to paycheck but give yourself the financial wiggle room you need.

You can read more about the purpose of Firefly III in the documentation.

Features

Firefly III is pretty feature packed. Some important stuff first:

It is completely self-hosted and isolated, and will never contact external servers until you explicitly tell it to.
It features a REST JSON API that covers almost every part of Firefly III.

The most exciting features are:

Create recurring transactions to manage your money.
Rule based transaction handling with the ability to create your own rules.

Then the things that make you go "yeah OK, makes sense".

A double-entry bookkeeping system.
Save towards a goal using piggy banks.
View income and expense reports.

And the things you would hope for but not expect:

2 factor authentication for extra security 🔒.
Supports any currency you want.
There is a Docker image.

And to organise everything:

Clear views that should show you how you're doing.
Easy navigation through your records.
Lots of charts because we all love them.

Many more features are listed in the documentation.

Who's it for?

This application is for people who want to track their finances, keep an eye on their money without having to upload their financial records to the cloud. You're a bit tech-savvy, you like open source software and you don't mind tinkering with (self-hosted) servers.

The Firefly III eco-system

Several users have built pretty awesome stuff around the Firefly III API. Check out these tools in the documentation.

Getting Started

There are many ways to run Firefly III

There is a demo site with an example financial administration already present.
You can install it on your server.
You can run it using Docker.
You can deploy via Kubernetes.
You can install it using Softaculous.
You can install it using AMPPS.
You can install it on Cloudron.
You can install it on Lando.
You can install it on Yunohost.

Contributing

You can contact me at james@firefly-iii.org, you may open an issue in the main repository or contact me through gitter and Mastodon.

Of course, there are some contributing guidelines and a code of conduct, which I invite you to check out.

I can always use your help squashing bugs, thinking about new features or translating Firefly III into other languages.

Sonarcloud scans the code of Firefly III. If you want to help improve Firefly III, check out the latest reports and take your pick!

There is also a security policy.

Support the development of Firefly III

Firefly III is a side gig. With your sponsorship or support, I can spend more time on Firefly III. So, if you like Firefly III, and if it helps you save lots of money, why not send me a dime for every dollar saved! 🥳

OK, that was a joke. But for real, when you feel Firefly III made your life better, please consider contributing as a sponsor. Please check out my Patreon and GitHub Sponsors page for more information. You can also buy me a ☕️ coffee at ko-fi.com or send something my way using Liberapay. Thank you for your consideration.

Sponsorships

Firefly III is sponsored by TestMu AI. Their support allows me to test Firefly III more easily and introduce even fewer bugs with every release.

Browser testing via TestMu AI:

License

This work is licensed under the GNU Affero General Public License v3.

Do you need help, or do you want to get in touch?

Do you want to contact me? You can email me at james@firefly-iii.org or get in touch through one of the following support channels:

GitHub Discussions for questions and support
Gitter.im for a good chat and a quick answer
GitHub Issues for bugs and issues
Mastodon for news and updates

Acknowledgements

Over time, many people have contributed to Firefly III. I'm grateful for their support and code contributions.

The Firefly III logo is made by the excellent Cherie Woo.

Paymenter/Paymenter

Free and open-source webshop solution for hostings

Paymenter

Open-Source Billing, Built for Hosting

Automate subscriptions, eliminate billing chaos, and grow your hosting business – without vendor lock-ins or hidden costs.

Website · Documentation · Live Demo · Extensions

Getting Started

Installation & Documentation

For a detailed explanation of how to install and configure Paymenter, take a look at our documentation here.

Or, get additional help via Community Discord.

Requirements

The requirements for Paymenter are the following:

PHP (8.3 or higher).
Composer
Webserver (Apache or Nginx)
Database (MariaDB)

What is Paymenter?

Paymenter is an open-source billing platform tailored for hosting companies. It simplifies the management of hosting services, providing a seamless experience for both providers and customers. Built on modern web technologies, Paymenter offers a flexible and robust solution for your hosting business needs.

Key Features:

User-Friendly Interface: Paymenter is designed with simplicity in mind, ensuring an intuitive experience for users of all technical levels.
Open Source and Extensible: As an open-source platform, Paymenter encourages community contributions and customization. Its architecture allows for extensive modifications and integration with other tools.
Efficient Management: Streamline your operations with Paymenter powerful admin panel, designed to enhance productivity and reduce overhead.
Secure and Reliable: Built with security as a priority, Paymenter ensures the protection of your data and transactions.
Community Driven: Join an engaged community of developers and hosting providers to collaborate and drive the future development of Paymenter.

Paymenter is available under the MIT license, offering you the freedom to adapt and evolve the platform to meet your specific requirements.

Sponsors

Thanks to all sponsors for helping fund Paymenter's development. Interested in becoming a sponsor?

License

Licensed under the MIT License.

googleapis/google-api-php-client

A PHP client library for accessing Google APIs

Google APIs Client Library for PHP

NOTE: please check to see if the package you'd like to install is available in our list of Google cloud packages first, as these are the recommended libraries.

Reference Docs: https://googleapis.github.io/google-api-php-client/
License: Apache 2.0

The Google API Client Library enables you to work with Google APIs such as Gmail, Drive or YouTube on your server.

These client libraries are officially supported by Google. However, the libraries are considered complete and are in maintenance mode. This means that we will address critical bugs and security issues but will not add any new features.

Google Cloud Platform

For Google Cloud Platform APIs such as Datastore, Cloud Storage, Pub/Sub, and Compute Engine, we recommend using the Google Cloud client libraries. For a complete list of supported Google Cloud client libraries, see googleapis/google-cloud-php.

Requirements

PHP 8.0 or higher

Developer Documentation

The docs folder provides detailed guides for using this library.

Installation

You can use Composer or simply Download the Release

Composer

The preferred method is via composer. Follow the installation instructions if you do not already have composer installed.

Once composer is installed, execute the following command in your project root to install this library:

composer require google/apiclient

If you're facing a timeout error then either increase the timeout for composer by adding the env flag as COMPOSER_PROCESS_TIMEOUT=600 composer install or you can put this in the config section of the composer schema:

{
    "config": {
        "process-timeout": 600
    }
}

Finally, be sure to include the autoloader:

require_once '/path/to/your-project/vendor/autoload.php';

This library relies on google/apiclient-services. That library provides up-to-date API wrappers for a large number of Google APIs. In order that users may make use of the latest API clients, this library does not pin to a specific version of google/apiclient-services. In order to prevent the accidental installation of API wrappers with breaking changes, it is highly recommended that you pin to the latest version yourself prior to using this library in production.

Cleaning up unused services

There are over 200 Google API services. The chances are good that you will not want them all. In order to avoid shipping these dependencies with your code, you can run the Google\Task\Composer::cleanup task and specify the services you want to keep in composer.json:

{
    "require": {
        "google/apiclient": "^2.15.0"
    },
    "scripts": {
        "pre-autoload-dump": "Google\\Task\\Composer::cleanup"
    },
    "extra": {
        "google/apiclient-services": [
            "Drive",
            "YouTube"
        ]
    }
}

This example will remove all services other than "Drive" and "YouTube" when composer update or a fresh composer install is run.

IMPORTANT: If you add any services back in composer.json, you will need to remove the vendor/google/apiclient-services directory explicitly for the change you made to have effect:

rm -r vendor/google/apiclient-services
composer update

NOTE: This command performs an exact match on the service name, so to keep YouTubeReporting and YouTubeAnalytics as well, you'd need to add each of them explicitly:

{
    "extra": {
        "google/apiclient-services": [
            "Drive",
            "YouTube",
            "YouTubeAnalytics",
            "YouTubeReporting"
        ]
    }
}

Download the Release

If you prefer not to use composer, you can download the package in its entirety. The Releases page lists all stable versions. Download any file with the name google-api-php-client-[RELEASE_NAME].zip for a package including this library and its dependencies.

Uncompress the zip file you download, and include the autoloader in your project:

require_once '/path/to/google-api-php-client/vendor/autoload.php';

For additional installation and setup instructions, see the documentation.

Examples

See the examples/ directory for examples of the key client features. You can view them in your browser by running the php built-in web server.

$ php -S localhost:8000 -t examples/

And then browsing to the host and port you specified (in the above example, http://localhost:8000).

Basic Example

// include your composer dependencies
require_once 'vendor/autoload.php';

$client = new Google\Client();
$client->setApplicationName("Client_Library_Examples");
$client->setDeveloperKey("YOUR_APP_KEY");

$service = new Google\Service\Books($client);
$query = 'Henry David Thoreau';
$optParams = [
  'filter' => 'free-ebooks',
];
$results = $service->volumes->listVolumes($query, $optParams);

foreach ($results->getItems() as $item) {
  echo $item['volumeInfo']['title'], "<br /> \n";
}

Authentication with OAuth

An example of this can be seen in examples/simple-file-upload.php.

Follow the instructions to Create Web Application Credentials
Download the JSON credentials

Set the path to these credentials using Google\Client::setAuthConfig:

$client = new Google\Client();
$client->setAuthConfig('/path/to/client_credentials.json');

Set the scopes required for the API you are going to call
```
$client->addScope(Google\Service\Drive::DRIVE);
```

Set your application's redirect URI

// Your redirect URI can be any registered URI, but in this example
// we redirect back to this same page
$redirect_uri = 'http://' . $_SERVER['HTTP_HOST'] . $_SERVER['PHP_SELF'];
$client->setRedirectUri($redirect_uri);

In the script handling the redirect URI, exchange the authorization code for an access token:

if (isset($_GET['code'])) {
    $token = $client->fetchAccessTokenWithAuthCode($_GET['code']);
}

Authentication with Service Accounts

An example of this can be seen in examples/service-account.php.

Some APIs (such as the YouTube Data API) do not support service accounts. Check with the specific API documentation if API calls return unexpected 401 or 403 errors.

Follow the instructions to Create a Service Account
Download the JSON credentials
Set the path to these credentials using the GOOGLE_APPLICATION_CREDENTIALS environment variable:
```
putenv('GOOGLE_APPLICATION_CREDENTIALS=/path/to/service-account.json');
```
Tell the Google client to use your service account credentials to authenticate:
```
$client = new Google\Client();
$client->useApplicationDefaultCredentials();
```
Set the scopes required for the API you are going to call
```
$client->addScope(Google\Service\Drive::DRIVE);
```
If you have delegated domain-wide access to the service account and you want to impersonate a user account, specify the email address of the user account using the method setSubject:
```
$client->setSubject($user_to_impersonate);
```

How to use a specific JSON key

If you want to a specific JSON key instead of using GOOGLE_APPLICATION_CREDENTIALS environment variable, you can do this:

$jsonKey = [
   'type' => 'service_account',
   // ...
];
$client = new Google\Client();
$client->setAuthConfig($jsonKey);

Making Requests

The classes used to call the API in google-api-php-client-services are autogenerated. They map directly to the JSON requests and responses found in the APIs Explorer.

A JSON request to the Datastore API would look like this:

POST https://datastore.googleapis.com/v1beta3/projects/YOUR_PROJECT_ID:runQuery?key=YOUR_API_KEY

{
    "query": {
        "kind": [{
            "name": "Book"
        }],
        "order": [{
            "property": {
                "name": "title"
            },
            "direction": "descending"
        }],
        "limit": 10
    }
}

Using this library, the same call would look something like this:

// create the datastore service class
$datastore = new Google\Service\Datastore($client);

// build the query - this maps directly to the JSON
$query = new Google\Service\Datastore\Query([
    'kind' => [
        [
            'name' => 'Book',
        ],
    ],
    'order' => [
        'property' => [
            'name' => 'title',
        ],
        'direction' => 'descending',
    ],
    'limit' => 10,
]);

// build the request and response
$request = new Google\Service\Datastore\RunQueryRequest(['query' => $query]);
$response = $datastore->projects->runQuery('YOUR_DATASET_ID', $request);

However, as each property of the JSON API has a corresponding generated class, the above code could also be written like this:

// create the datastore service class
$datastore = new Google\Service\Datastore($client);

// build the query
$request = new Google\Service\Datastore_RunQueryRequest();
$query = new Google\Service\Datastore\Query();
//   - set the order
$order = new Google\Service\Datastore_PropertyOrder();
$order->setDirection('descending');
$property = new Google\Service\Datastore\PropertyReference();
$property->setName('title');
$order->setProperty($property);
$query->setOrder([$order]);
//   - set the kinds
$kind = new Google\Service\Datastore\KindExpression();
$kind->setName('Book');
$query->setKinds([$kind]);
//   - set the limit
$query->setLimit(10);

// add the query to the request and make the request
$request->setQuery($query);
$response = $datastore->projects->runQuery('YOUR_DATASET_ID', $request);

The method used is a matter of preference, but it will be very difficult to use this library without first understanding the JSON syntax for the API, so it is recommended to look at the APIs Explorer before using any of the services here.

Making HTTP Requests Directly

If Google Authentication is desired for external applications, or a Google API is not available yet in this library, HTTP requests can be made directly.

If you are installing this client only to authenticate your own HTTP client requests, you should use google/auth instead.

The authorize method returns an authorized Guzzle Client, so any request made using the client will contain the corresponding authorization.

// create the Google client
$client = new Google\Client();

/**
 * Set your method for authentication. Depending on the API, This could be
 * directly with an access token, API key, or (recommended) using
 * Application Default Credentials.
 */
$client->useApplicationDefaultCredentials();
$client->addScope(Google\Service\Plus::PLUS_ME);

// returns a Guzzle HTTP Client
$httpClient = $client->authorize();

// make an HTTP request
$response = $httpClient->get('https://www.googleapis.com/plus/v1/people/me');

Caching

It is recommended to use another caching library to improve performance. This can be done by passing a PSR-6 compatible library to the client:

use League\Flysystem\Adapter\Local;
use League\Flysystem\Filesystem;
use Cache\Adapter\Filesystem\FilesystemCachePool;

$filesystemAdapter = new Local(__DIR__.'/');
$filesystem        = new Filesystem($filesystemAdapter);

$cache = new FilesystemCachePool($filesystem);
$client->setCache($cache);

In this example we use PHP Cache. Add this to your project with composer:

composer require cache/filesystem-adapter

Updating Tokens

When using Refresh Tokens or Service Account Credentials, it may be useful to perform some action when a new access token is granted. To do this, pass a callable to the setTokenCallback method on the client:

$logger = new Monolog\Logger();
$tokenCallback = function ($cacheKey, $accessToken) use ($logger) {
  $logger->debug(sprintf('new access token received at cache key %s', $cacheKey));
};
$client->setTokenCallback($tokenCallback);

Debugging Your HTTP Request using Charles

It is often very useful to debug your API calls by viewing the raw HTTP request. This library supports the use of Charles Web Proxy. Download and run Charles, and then capture all HTTP traffic through Charles with the following code:

// FOR DEBUGGING ONLY
$httpClient = new GuzzleHttp\Client([
    'proxy' => 'localhost:8888', // by default, Charles runs on localhost port 8888
    'verify' => false, // otherwise HTTPS requests will fail.
]);

$client = new Google\Client();
$client->setHttpClient($httpClient);

Now all calls made by this library will appear in the Charles UI.

One additional step is required in Charles to view SSL requests. Go to Charles > Proxy > SSL Proxying Settings and add the domain you'd like captured. In the case of the Google APIs, this is usually *.googleapis.com.

Controlling HTTP Client Configuration Directly

Google API Client uses Guzzle as its default HTTP client. That means that you can control your HTTP requests in the same manner you would for any application using Guzzle.

Let's say, for instance, we wished to apply a referrer to each request.

use GuzzleHttp\Client;

$httpClient = new Client([
    'headers' => [
        'referer' => 'mysite.com'
    ]
]);

$client = new Google\Client();
$client->setHttpClient($httpClient);

Other Guzzle features such as Handlers and Middleware offer even more control.

Partial Consent and Granted Scopes

When using OAuth2 3LO (e.g. you're a client requesting credentials from a 3rd party, such as in the simple file upload example), you may want to take advantage of Partial Consent.

To allow clients to only grant certain scopes in the OAuth2 screen, pass the querystring parameter for enable_serial_consent when generating the authorization URL:

$authUrl = $client->createAuthUrl($scope, ['enable_serial_consent' => 'true']);

Once the flow is completed, you can see which scopes were granted by calling getGrantedScope on the OAuth2 object:

// Space-separated string of granted scopes if it exists, otherwise null.
echo $client->getOAuth2Service()->getGrantedScope();

Service Specific Examples

YouTube: https://github.com/youtube/api-samples/tree/master/php

How Do I Contribute?

Please see the contributing page for more information. In particular, we love pull requests - but please make sure to sign the contributor license agreement.

Frequently Asked Questions

What do I do if something isn't working?

For support with the library the best place to ask is via the google-api-php-client tag on StackOverflow: https://stackoverflow.com/questions/tagged/google-api-php-client

If there is a specific bug with the library, please file an issue in the GitHub issues tracker, including an example of the failing code and any specific errors retrieved. Feature requests can also be filed, as long as they are core library requests, and not-API specific: for those, refer to the documentation for the individual APIs for the best place to file requests. Please try to provide a clear statement of the problem that the feature would address.

I want an example of X!

If X is a feature of the library, file away! If X is an example of using a specific service, the best place to go is to the teams for those specific APIs - our preference is to link to their examples rather than add them to the library, as they can then pin to specific versions of the library. If you have any examples for other APIs, let us know and we will happily add a link to the README above!

Why do some Google\Service classes have weird names?

The Google\Service classes are generally automatically generated from the API discovery documents: https://developers.google.com/discovery/. Sometimes new features are added to APIs with unusual names, which can cause some unexpected or non-standard style naming in the PHP classes.

How do I deal with non-JSON response types?

Some services return XML or similar by default, rather than JSON, which is what the library supports. You can request a JSON response by adding an 'alt' argument to optional params that is normally the last argument to a method call:

$opt_params = array(
  'alt' => "json"
);

How do I set a field to null?

The library strips out nulls from the objects sent to the Google APIs as it is the default value of all of the uninitialized properties. To work around this, set the field you want to null to Google\Model::NULL_VALUE. This is a placeholder that will be replaced with a true null when sent over the wire.

Code Quality

Run the PHPUnit tests with PHPUnit. You can configure an API key and token in BaseTest.php to run all calls, but this will require some setup on the Google Developer Console.

phpunit tests/

Coding Style

To check for coding style violations, run

vendor/bin/phpcs src --standard=style/ruleset.xml -np

To automatically fix (fixable) coding style violations, run

vendor/bin/phpcbf src --standard=style/ruleset.xml

SpartnerNL/Laravel-Excel

🚀 Supercharged Excel exports and imports in Laravel

Supercharged Excel exports and imports

A simple, but elegant Laravel wrapper around PhpSpreadsheet exports and imports.

Quickstart · Documentation · Video Course · Nova · Blog · Contributing · Support

✨ Features

Easily export collections to Excel. Supercharge your Laravel collections and export them directly to an Excel or CSV document. Exporting has never been so easy.
Supercharged exports. Export queries with automatic chunking for better performance. You provide us the query, we handle the performance. Exporting even larger datasets? No worries, Laravel Excel has your back. You can queue your exports so all of this happens in the background.
Supercharged imports. Import workbooks and worksheets to Eloquent models with chunk reading and batch inserts! Have large files? You can queue every chunk of a file! Your entire import will happen in the background.
Export Blade views. Want to have a custom layout in your spreadsheet? Use a HTML table in a Blade view and export that to Excel.

🎓 Learning Laravel Excel

You can find the full documentation of Laravel Excel on the website.

We welcome suggestions for improving our docs. The documentation repository can be found at https://github.com/SpartnerNL/laravel-excel-docs.

Some articles and tutorials can be found on our blog: https://medium.com/maatwebsite/laravel-excel/home

📬 License & Postcardware

Laravel Excel is created with love and care by Spartner (formerly known as Maatwebsite) to give back to the Laravel community. It is completely free (MIT license) to use, however the package is licensed as Postcardware. This means that if it makes it to your production environment, we would very much appreciate receiving a postcard from your hometown.

Spartner Markt 2 6231 LS Meerssen The Netherlands.

More about the license can be found at: https://docs.laravel-excel.com/3.1/getting-started/license.html

Created by Spartner (formerly Maatwebsite)

We are a strategic development partner, creating web-based custom built software from Laravel. In need of a digital solution for your challenge? Give us a call.

https://spartner.software info@spartner.nl +31 (0) 10 - 7449312

🔧 Supported Versions

Versions will be supported for a limited amount of time.

Version	Laravel Version	Php Version	Support
2.1	<=5.6	<=7.0	Unsupported since 15-5-2018
3.0	^5.5	^7.0	Unsupported since 31-12-2018
3.1	>=5.8 \| <=13.x	^7.2 \| ^8.0	New features