|
|
@@ -1,87 +1,45 @@
|
|
|
# Organizr
|
|
|
HTPC/Homelab Services Organizer - Written in PHP
|
|
|
|
|
|
-## Setup
|
|
|
-**Requirements:**
|
|
|
+### About
|
|
|
+Do you have quite a bit of services running on your computer or server? Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports? Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage. You can then work on your server with ease. You can even open up two tabs side by side. Want to give users access to some Tabs? No problem, just enable user support and have them make an account. Want guests to be able to visit too? Enable Guest support for those tabs.
|
|
|
|
|
|
-- A webserver (nginx, Apache, IIS or any other webserver)
|
|
|
-- PHP 5.5+
|
|
|
-- SQLite (uncomment the php_sqlite extension in php.ini file and point it to the right directory)
|
|
|
-
|
|
|
-## Downloading
|
|
|
-- To set it up, clone this repository:
|
|
|
-`` git clone https://github.com/causefx/Organizr `` or download the ZIP-file.
|
|
|
-- Place all files on a publically accessible webserver, either directly in the root, or inside a directory called ``Dashboard`` or whatever you want it to be called. Please set the correct user permissions on the directory and it's files.
|
|
|
-
|
|
|
-## Instructions
|
|
|
-Upload all contents of zip or git pull the zip into the folder you want to have this on your webserver.
|
|
|
-
|
|
|
-Set the correct file permission on the files.
|
|
|
-
|
|
|
-Open up the index.php file in your browser once everything is uploaded. The script take you through to create an admin account and then you will sign in.
|
|
|
-
|
|
|
-The Settings page will load automatically so now you can create tabs to whatever you like in whatever order.
|
|
|
-
|
|
|
-When creating Tabs, type in the name of the tab and hit ``Enter`` this will drop it down to the list where you can fill out the rest of the data.
|
|
|
-
|
|
|
-Name = The Name of Your Tab
|
|
|
-
|
|
|
-URL = URL of The Tab's Location
|
|
|
-
|
|
|
-Icon = Font Awesone icon
|
|
|
-
|
|
|
-Icon URL = If this is filled out, it will use this icon instead of the Font Awesome one
|
|
|
-
|
|
|
-Default = Checking this option will make this tab load first
|
|
|
-
|
|
|
-Active = Checking this option will enable the tab for your page
|
|
|
-
|
|
|
-User = This option enables this tab for Admins and Users but not Guests
|
|
|
-
|
|
|
-Guest = This option enables the tab for Admin, Users and Guests
|
|
|
-
|
|
|
-No iFrame = This option makes it so when you click the tab it will open in a new window (Used for apps that block iFrames)
|
|
|
-
|
|
|
-
|
|
|
-Once the cookie expires you will need to login again
|
|
|
-
|
|
|
-If you aren't logged in you or any guest will only see your guest enabled tabs
|
|
|
+## Requirement & Downloading & Instructions
|
|
|
+- See Wiki
|
|
|
|
|
|
## Desktop Images
|
|
|
-
|
|
|
-Guest View
|
|
|
-
|
|
|
-
|
|
|
-Login View
|
|
|
-
|
|
|
-
|
|
|
-Main View
|
|
|
-
|
|
|
-
|
|
|
-Settings View
|
|
|
-
|
|
|
-
|
|
|
-Color/Theme View
|
|
|
-
|
|
|
-
|
|
|
-User Management View
|
|
|
-
|
|
|
-
|
|
|
-About/Help View
|
|
|
-
|
|
|
-
|
|
|
-Side Menu Open View
|
|
|
-
|
|
|
-
|
|
|
-Logout View
|
|
|
-
|
|
|
-
|
|
|
-## Mobile Images
|
|
|
-
|
|
|
-Main View
|
|
|
-<img src="http://i.imgur.com/pfoowtS.png" height="400">
|
|
|
-
|
|
|
-Menu Open View
|
|
|
-<img src="http://i.imgur.com/qQc7XKO.png" height="400">
|
|
|
+<img src="https://cloud.githubusercontent.com/assets/16184466/23820729/64555922-05dc-11e7-9860-305f72e431d7.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820730/728ccad4-05dc-11e7-8b9a-717f41485c73.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820731/83c65e00-05dc-11e7-85d6-2a425db42b69.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820734/922b077a-05dc-11e7-80da-901d6a398ac1.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820738/9b607186-05dc-11e7-9cca-12602ea8529a.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820742/ace5be48-05dc-11e7-825d-a19a285f1b57.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820896/7a547ba0-05e0-11e7-9a19-f66bae14c88f.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820761/06ff2fc2-05dd-11e7-9e30-e0df4a5c93c9.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820763/0f19a66a-05dd-11e7-8b91-1fec388ab20c.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820767/1d00deec-05dd-11e7-8992-64dbf836ed8a.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820769/29e09c10-05dd-11e7-8412-241a5f087532.png" width="23%"></img> <img src="https://cloud.githubusercontent.com/assets/16184466/23820772/3cadde34-05dd-11e7-8441-8c6bab6b8f47.png" width="23%"></img>
|
|
|
+
|
|
|
+## Feature List
|
|
|
+- Custom tabs for your services
|
|
|
+- Fullscreen Support
|
|
|
+- Pin/Unpin sidebar
|
|
|
+- Mobile support
|
|
|
+- Set default page on launch
|
|
|
+- Enable or Disable loading icon
|
|
|
+- Customise loading icon
|
|
|
+- Upload new icons with ease
|
|
|
+- Enable or disable iFrame for your tabs
|
|
|
+- User management support: Create, delete and promote users from the user management console
|
|
|
+- 3 user classes available: admin, user, guest
|
|
|
+- 9 Different themes available
|
|
|
+- Personalise any theme: Customise the look and feel of Organizr with access to the colour palette
|
|
|
+- Organizr login log viewer
|
|
|
+- Fail2ban support (see wiki)
|
|
|
+- Nginx Cookie Authentication support
|
|
|
+- Protect new user account creation with registration password
|
|
|
+- 'Forgot Password' support [receive an email with your new password, prerequisites: mail server setup]
|
|
|
+- Multiple login support
|
|
|
+- Keyboard shortcut support (Check help tab in settings)
|
|
|
+- Split-screen support (view two tabs side-by-side on Organizr)
|
|
|
+- Gravatr Support
|
|
|
+- Loading screen icon support
|
|
|
+- Customise the top bar by adding your own site logo or site name
|
|
|
+- Slim option available for top bar
|
|
|
+- Additional language support [EN, DE, ES, FR, IT, NL]
|
|
|
+- Quick access tabs [access your tabs quickly e.g. www.example.com/#Sonarr]
|
|
|
+
|
|
|
+Thanks to everyone that helped!
|
|
|
+Special Shout-out to: [elmerfdz](https://github.com/elmerfdz) & [pyrostic](https://github.com/pyrostic) & [rix1337](https://github.com/rix1337)
|
|
|
|
|
|
Theme Distributed with Extended License from Creative Market
|
causefx