Home

Concept

• Ebuild will take care of dependencies required to use Froxlor
• Ebuild / Froxlor will not take care of starting/restarting services or register services for autostart
• USE flags of this ebuild can be used to install/ensure dependencies for optional features
  • Configuration inside Froxlor will still be necessary in most cases
• Ebuild/emerge honor CONFIG_PROTECT -> you have to manually resolve config file conflicts (e.g. for apache) by using appropriate tool like dispatch-conf
  • However Froxlor service configuration or cron jobs may overwrite config files without honoring CONFIG_PROTECT
• There will be no "How to use Gentoo" guide. You should know Gentoo basics or start reading official Gentoo documentation (https://www.gentoo.org/get-started/, https://wiki.gentoo.org, ...) before using this ebuild.

Limitations

• v9999 might not contain configurations/dependencies/... required by latest Froxlor commits
• Untested features:
  • lighttpd (sry deprecated, anyone actually using + got time to test?)
  • PowerDNS with BIND backend

Usage

1. Read this document from top to bottom without actually applying any changes to any system
   • Why? It might save you a lot of time in the end ;)
2. Sync main repo and emerge eselect-repository, git

   emerge --sync && emerge -avj --noreplace app-eselect/eselect-repository dev-vcs/git
   

3. Add repository and sync it

   eselect repository add froxlor git https://github.com/z-e-r-0-t/Gentoo-Ebuild.git \
   && emaint sync --repo froxlor
   

4. Add www-apps/froxlor, sys-auth/libnss-extrausers, net-analyzer/goaccess to accepted keywords

   echo ">=www-apps/froxlor-2.1.0 **" >> /etc/portage/package.accept_keywords/froxlor
   echo ">=sys-auth/libnss-extrausers-0.6 **" >> /etc/portage/package.accept_keywords/froxlor
   echo "<net-analyzer/goaccess-9999 **" >> /etc/portage/package.accept_keywords/froxlor
   

5. Adjust Froxlor + dependencies use flags
   • Check packages that will be emerged + required USE flag changes: emerge -pv www-apps/froxlor
   • Actual USE flags depend on your preferences
   • Default USE flag changes required

   echo "www-servers/apache apache2_modules_proxy apache2_modules_proxy_fcgi suexec" >> /etc/portage/package.use/froxlor
   echo "net-ftp/proftpd mysql softquota" >> /etc/portage/package.use/froxlor
   

6. Emerge Froxlor

   emerge -avj www-apps/froxlor
   

7. Proceed with installation according to ebuild output in console
   • Run dispatch-conf to apply required config changes (ebuild comes with default configs to make webinstaller work)
   • Start/restart required services (e.g. apache, php-fpm, mariadb, ... depending on your USE flags)
   • continue with: https://docs.froxlor.org/latest/general/installation/tarball.html#_3-create-privileged-database-user, webinstaller, service configuration, ...

Misc

PHP USE flags

• This ebuild only ensures basic USE flags for PHP in order to make Froxlor work
• You might consider adding these too:
  • argon2 (better password hashing with Froxlor)
  • pcntl (parallel execution of jobs with Froxlor)
• Manually emerge dev-php/pecl-gnupg for encrypted data dump support with Froxlor

Feedback / Contribution / ...

• YES PLEASE
• Git branches you might like:
  • https://github.com/z-e-r-0-t/Gentoo-Ebuild/tree/dev (dev for ebuild)
  • https://github.com/z-e-r-0-t/Froxlor/tree/gentoo_xml (.xml dev for Gentoo)
• How to contribute:
  • Default GitHub stuff (Issue, Pull Request, ...)
  • PM me on Discord zer0t / zer0t#9267 (Froxlor development channel might be another possibility)