Skip to content

Latest commit

 

History

History
165 lines (125 loc) · 8.52 KB

README.md

File metadata and controls

165 lines (125 loc) · 8.52 KB

Admidio

Admidio is a free open source user management system for websites of organizations and groups. The system has a flexible role model so that it’s possible to reflect the structure and permissions of your organization. You can create an individual profile for your members by adding or removing profile fields. Additional to these functions the system contains several modules like member lists, event manager, messages, photo album or a documents & files area.

logo

GitHub issues GitHub forks GitHub stars GitHub top language GitHub license

Supported languages: 🇬🇧 🇩🇪 🇫🇷 🇪🇸 🇳🇱 🇩🇰 🇸🇪 🇫🇮 🇧🇷 🇵🇹 🇮🇹 🇮🇩 🇳🇴 🇨🇳 🇬🇷 🇧🇬

Table of contents

Features

  • create roles and groups that reflects the structure of your organization
  • customize the user profile with your own profile fields
  • relate your members to each other (e.g. spouse, mother - son)
  • create individual membership lists of your roles
  • publish all your events online and let the members participate
  • create photo albums and let the users send ecards
  • send html emails to your users, roles and groups
  • export all lists to csv, excel or pdf
  • import users from csv
  • and much more ...

Installation

You can install Admidio on your webspace if the script language PHP in version 7.2 or higher is available. Admidio also needs a MySQL (version 5.0 or higher) or PostgreSQL (version 9.0 or higher) database to run.

For a successful installation please follow our online instructions. There we describe step by step the installation process.

Update

Please follow our online instructions for a successful update to a new version of Admidio.

Short update description:

  • Delete the folder adm_program and the index.php of the previous version.
  • Copy folder adm_program and the index.php from the new version to this place.
  • Update the folder adm_plugins with the new delivered plugins.
  • Call the index.php in your Admidio folder and start the update.
  • Maybe changes to the theme in the folder adm_theme are necessary.

If you perform an update from version 2.x or 3.x to version 4.x please read our special update instructions.

Docker

Admidio could also be used within a docker enviroment.
We provide a Dockerfile that allows you to easily create and use your own Docker image.

The easiest way is to use our prebuilt images from Dockerhub. You can start an admidio docker container with the following command:

docker run --detach -it --name Admidio \
  --memory="1024m" --cpu-quota="80000" --cpuset-cpus="0-1" \
  -p 8080:8080 \
  --restart="unless-stopped" \
  -v Admidio-files:/var/www/admidio/adm_my_files \
  -v Admidio-themes:/var/www/admidio/adm_themes \
  -v Admidio-plugins:/var/www/admidio/adm_plugins \
  admidio/admidio:latest

For detailed docker usage see README-Docker.md

Contributing

There are several ways how you can contribute to Admidio.

The easiest way to support us will be our forum. There you can help other users with your knowledge and answer questions. Try to reproduce errors that other users report or give hints to some problems.

Another way is our documentation. We want to deliver a helpful documentation to our users. But there is a lot work to do. You see our current state in the wiki. Just ask us for write permissions in the wiki and you can start.

We always need persons who translate our software Admidio into another language or just update an existing language to the current version. We also need people who translate our documentation into english.

If you have knowledge in PHP programming and know something about HTML, CSS and JavaScript then you can start to help us to improve the software Admidio. You will find our software at GitHub. The handling with GitHub and branches is described in our wiki.

So if you find yourself in one of the above points then we invite you to join our team and help to improve Admidio to one of the best free membership software.

Changelog

Please visit our changelog for detail information about the bugfixes and enhancements in each version.

Donation

If you like the software and our project then we are happy if you donate some money to the project.

Copyright and License

Admidio is release under the GNU General Public License 2. You are free to use, modify and distribute this software, as long as the copyright header within the html page and source code is left intact. If you want to support us we are happy if you don't remove the link to Admidio within the login dialog.

Credits

Admidio contains several scripts, icons and modules of other projects. We want to thank the people behind these projects for contributing and sharing great software.

  • Admidio Team: The core developers of this project
  • Bootstrap: HTML, CSS and JS framework
  • Bootstrap-Datepicker: Datepicker for Bootstrap
  • CKEditor: Javascript-Editor
  • Composer: A Dependency Manager for PHP.
  • Cookie Consent: The most popular solution to the EU cookie law
  • Datatables: Table plugin for jQuery
  • Font Awesome: Vector icons and social logos
  • HTML Purifier: PHP code to purify & filter HTML
  • James Heinrich: backupDB
  • jQuery: JavaScript-Library
  • jQuery-File-Upload: jQuery file upload plugin
  • Lightbox: Lightbox for Bootstrap
  • Luxon: A powerful, modern, and friendly wrapper for JavaScript dates and times.
  • Monolog: Logging for PHP
  • NobleCount: NobleCount… for a more ‘proper’ count of the characters remaining.
  • PHPMailer: Email sending library for PHP
  • PHPSpreadsheet: PhpSpreadsheet offers a set of classes that allow you to read and write various spreadsheet file formats.
  • PSR Log: An interface that describes a logger.
  • ramsey/uuid: A PHP library for generating and working with UUIDs.
  • SecurImage: PHP CAPTCHA script for generating complex images and CAPTCHA codes to protect forms from spam and abuse.
  • Select2: jQuery replacement for select boxes
  • Smarty: PHP template engine
  • TCPDF: Open Source PHP class for generating PDF documents.
  • zxcvbn: Add password strength indicator
  • zxcvbn-php: Test password strength in the backend

Copyright (c) 2004 - 2022 The Admidio Team