Code Monkey home page Code Monkey logo

authentic-theme's Introduction

##Contents

##About Authentic is Webmin/Usermin/Virtualmin/Cloudmin theme based on Bootstrap and Font Awesome that is made with love. It uses CodeMirror to highlight config files and show line numbers, when editing manually, TinyMCE to compose comprehensive HTML based messages and DataTables to add advanced interaction controls to modules' tables. Theme runs using latest releases of dependent software (mentioned above), supporting all in-built modules (even ancient ones) and third-party modules, including ConfigServer Security & Firewall.

ScreenShot

####Principles

  • Make the theme fully support all Webmin/Usermin modules
  • Be as beautiful, fast, light and easy to use as possible
  • Be compatible with all platforms and support mobile devices

####Features

  • Configurable theme options using Webmin UI
  • Favorites feature for any content page
  • Unprecedentedly convenient and complete navigation menu for both desktop and mobile
  • Autocomplete for quick and effective navigation with ability to execute shell commands *
  • Hotkeys for quick access control
  • Dynamically updated page title based on current module
  • Security mail notifications
  • Code highlight when editing files manually
  • Extensive list of customizable theme options, with ability to embed user logos, styles and scripts
  • Extended support for Filemin and ConfigServer Security & Firewall modules

####Requirements

  • Webmin 1.730+ (required), Usermin 1.640+ (optional), Virtualmin 4.14+ (optional), Cloudmin 8.01+ (optional)

####Recommended modules

  • Installed Net::SSLeay module, to make automatic update notifications work

####Browser support

###### Chrome 24+

###### Firefox 5+

###### Opera 18+

###### Safari 6+

###### Edge 20+

###### IE 10+

###FAQ ####How to install Authentic Theme?

#####Webmin

To install Autentic Theme from repository, just clone it into your wherever Webmin binary folder (libexec) is. After that, you must rename authentic-theme-master directory to authentic-theme to make the theme work properly. Besides, you could just download the theme directly and install it using Webmin:

Webmin->Webmin Configuration->Webmin Themes->Install themes->From uploaded file

#####Usermin Use the same procedure as described above to install the theme for Usermin:

Webmin->Usermin Configuration->Usermin Themes->Install themes->From uploaded file

#####Virtualmin/Cloudmin There is no need to take any additional actions. In case Virtualmin or/and Cloudmin modules are installed, it will be automatically detected and supported.

####How to update Authentic Theme automatically? The theme has inbuilt feature to notify an administrative user to install updates. To enable this feature, turn Check for Authentic Theme updates on in theme settings.

####How do I customize the theme? Theme has configurable options, that are located in Webmin->Webmin Configuration->Webmin Themes. There as well, you can set custom logos, styles and scripts.

####How do I make user palettes work? Authentic Theme utilizes built-in, custom color palettes, that a user can define using theme's extensions. It's possible, by using theme's CSS extensions, to pass user custom selector, such as user-palette-1, user-palette-2, user-palette-3, user-palette-4, user-palette-5, user-palette-6, user-palette-7, user-palette-8, user-palette-9 and user-palette-10 to enable a usage of user palettes. For example, in order to use user-palette-1, in the theme's settings, you would need to set the option Navigation Menu Color to the value of User Palette 1. After that, provide a custom code to the theme's CSS extension, with a pre-built template, corresponding with custom theme's identification.

####How do I execute shell command using search filed? Type ! in search, followed by your command. Example: ! ls -lsaZ /root. It's required to have Command Shell module available.

####How do I make the theme load faster? Webmin has in-built option to compress static files. It's possible to enable this feature by going to Webmin->Webmin Configuration->Web Server Options and setting Gzip compress static files option to Use pre-compressed file and compress dynamically.

###Extended support for bundled/third-party modules

####Filemin Theme has great support for this module, by adding numerous mast-have features. Most noticeable are listing without page reload (using XHR requests) and full keyboard support, which enables you to use Filemin just as normal desktop browser.

#####List of keyboard shortcuts

  • alphanumeric typing - quick search
  • up/down, home/end - cursor position
  • enter - descent into selected
    • in case there is only one row filtered, enter on search field will perform trigger
  • spacebar - select current row
  • backspace - previous folder
  • * - inverse select
  • + - select all
  • - - deselect all
  • F2 - change permissions
  • F3 - change ownership
  • F4 - edit where possible
  • F5/Shift+F5 - compress/decompress
  • F6 - rename
  • Shift+F4/F7 - new file/folder
  • Shift+F7 - search
  • F8/Del - delete
  • Ctrl+X/C/V - Cut/Copy/Paste
  • Ctrl+Enter/Ctrl+Shift+Enter - Save/Save and close currently edited file
  • Theme reload hot key - reload current directory

####ConfigServer Security & Firewall Theme only re-renders this module and adds support for code highlight, when editing files manually.

###Troubleshoot

  1. Automatic updates notification feature doesn't work or Can't locate Net/SSLeay.pm in ..)
    This happens because Webmin is trying to open a link and download the theme using https protocol. Net::SSLeay - is high level functions for accessing web servers (by using HTTP/HTTPS). You can install it using CPAN module in Webmin or using CLI. Package name is perl-Net-SSLeay. Besides, in case you have mentioned module installed and automatic update feature still doesn't work, you would have to also install either LWP::Protocol::https or Bundle::LWP using CPAN or by package name perl-LWP-Protocol-https or perl-libwww-perl respectively;
  2. Strange  character is appeared in text-editor mode
    This happens because of encoding disparity. To fix this, just set language in Webmin to UTF-8 and make sure that your browser also has detected it as UTF-8;
  3. I get HEAD 404 (File not found) in console
    That is not really an error. It happens, when theme is checking, if needed URL exists and can be loaded;
  4. Page loader/spinner got stuck
    To prematurely dismiss a loader, click the Escape key for the right loader and Ctrl+Escape for the left, or loader's close button, right next to it.

###Development ####Lead developer

###Contributions

####Translations

###Donation

Overall development of this theme has already passed the stage of 1100 hours. I'm happy to provide Authentic Theme for free but please know, that it would mean a World to me, if you send me a donation. It doesn't matter how big or small your donation is. I appreciate all donations. Each donation will help me to pay my bills, excite future development and improve your everyday experience, while working with the theme.

PayPal or Yandex Money: 41001414241949

License

Authentic Theme is released under the MIT License

authentic-theme's People

Contributors

iliajie avatar majk-p avatar paskers avatar dreista avatar rvanlaak avatar

Watchers

James Cloos avatar Robert W. Baumgartner avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.