mirror of
https://github.com/getgrav/grav-plugin-admin.git
synced 2026-01-06 15:43:01 +01:00
Getting ready for release
This commit is contained in:
Andy Miller
5
CHANGELOG.md
Normal file
5
CHANGELOG.md
Normal file
@@ -0,0 +1,5 @@
|
||||
# v0.1.0
|
||||
## 08/04/2015
|
||||
|
||||
1. [](#new)
|
||||
* ChangeLog started...
|
||||
2
LICENSE
2
LICENSE
@@ -1,6 +1,6 @@
|
||||
The MIT License (MIT)
|
||||
|
||||
Copyright (c) 2014 Grav
|
||||
Copyright (c) 2015 Grav
|
||||
|
||||
Permission is hereby granted, free of charge, to any person obtaining a copy
|
||||
of this software and associated documentation files (the "Software"), to deal
|
||||
|
||||
78
README.md
78
README.md
@@ -1,4 +1,76 @@
|
||||
grav-plugin-admin
|
||||
=================
|
||||
# Grav Standard Administration Panel Plugin
|
||||
|
||||
This **admin plugin** for [Grav](http://github.com/getgrav/grav) is an HTML user interface that provides a convenient way to configure Grav and easily create and modify pages. This will remain a totally optional plugin, and is not in any way required or needed to use Grav effectively. In fact, the admin provides an intentionally limited view to ensure it remains easy to use and not overwhelming. I'm sure power users will still prefer to work with the configuration files directly.
|
||||
|
||||
| IMPORTANT!!! This plugin is currently in development as is to be considered a **beta release**. As such, use this in a production environment **at your own risk!**.
|
||||
|
||||
# Features
|
||||
|
||||
* User login with automatic password encryption
|
||||
* Forgot password functionality
|
||||
* Logged-in-user management
|
||||
* One click Grav core updates
|
||||
* Dashboard with maintenance status, site activity and latest page updates
|
||||
* Ajax-powered backup capability
|
||||
* Ajax-powered clear-cache capability
|
||||
* System configuration management
|
||||
* Site configuration management
|
||||
* Normal and Expert modes which allow editing via forms or YAML
|
||||
* Page listing with filtering and search
|
||||
* Page creation, editing, moving, copying, and deleting
|
||||
* Powerful syntax highlighting code editor with instant Grav-powered preview
|
||||
* Editor features, hot keys, toolbar, and distraction-free fullscreen mode
|
||||
* Drag-n-drop upload of page media files including drag-n-drop placement in the editor
|
||||
* One click theme and plugin updates
|
||||
* Plugin manager that allows listing and configuration of installed plugins
|
||||
* Theme manager that allows listing and configuration of installed themes
|
||||
* GPM-powered installation of new plugins and themes
|
||||
|
||||
# Support
|
||||
|
||||
#### Support
|
||||
|
||||
We have tested internally, but we hope to use this public beta phase to identify, isolate, and fix issues related to the plugin to ensure it is as solid and reliable as possible.
|
||||
|
||||
For **live chatting**, please use the dedicated [Gitter Chat Room for the admin plugin](https://gitter.im/grav/grav-plugin-admin) for dicussions directly related to the admin plugin.
|
||||
|
||||
For **bugs, features, improvements**, please ensure you [create issues in the admin plugin GitHub repository](https://github.com/grav/grav-plugin-admin).
|
||||
|
||||
# Installation
|
||||
|
||||
The admin plugin actually requires the help of 3 other plugins, so to get the admin plugin to work you first need to install **admin**, **login**, **forms**, and **email** plugins. These are available via GPM, and because the plugin has dependencies you just need to proceed and install the admin plugin, and agree when prompted to install the others:
|
||||
|
||||
```
|
||||
$ bin/gpm install admin
|
||||
```
|
||||
|
||||
# Usage
|
||||
|
||||
Upon completion of the installation the next thing you need to do is create a user account in a file called `users/accounts/admin.yaml`:
|
||||
|
||||
```
|
||||
username: admin
|
||||
password: password
|
||||
email: youremail@mail.com
|
||||
fullname: Johnny Appleseed
|
||||
title: Site Administrator
|
||||
access:
|
||||
admin:
|
||||
login: true
|
||||
super: true
|
||||
```
|
||||
|
||||
Of course you should edit your `email`, `password`, `fullname`, and `title` to suit your needs.
|
||||
|
||||
By default you can access the admin by pointing your browser to `http://yoursite.com/admin`. Here you simply log in with the `username` and `password` you entered above.
|
||||
|
||||
| After logging in, your **plaintext password** will be removed and replaced by an **encrypted** one.
|
||||
|
||||
# Standard Free & Paid Pro Versions
|
||||
|
||||
If you have been following the blog, twitter, gitter.im chat etc, you probably already know now that our intention is to provide two versions.
|
||||
|
||||
The **standard free version**, is actually still very powerful, and has more functionality than most commercial flat-file CMS systems.
|
||||
|
||||
We also intend to release in the near future a more feature-rich **pro version** that will have enhanced functionality and some additional nice-to-have capabilities. This pro version will be a **paid** plugin the price of which is not yet 100% finalized.
|
||||
|
||||
Grav Admin Plugin
|
||||
|
||||
@@ -1,12 +1,15 @@
|
||||
name: Administration Panel - Basic
|
||||
version: 1.0.0
|
||||
name: Administration Panel - Standard
|
||||
version: 0.1.0
|
||||
description: Adds an advanced administration panel to manage your site
|
||||
icon: empire
|
||||
author:
|
||||
name: Team Grav
|
||||
email: devs@getgrav.org
|
||||
url: http://getgrav.org
|
||||
homepage: https://github.com/getgrav/grav-plugin-admin
|
||||
keywords: admin, plugin, manager, panel
|
||||
bugs: https://github.com/getgrav/grav-plugin-admin/issues
|
||||
license: MIT
|
||||
|
||||
form:
|
||||
validation: loose
|
||||
@@ -89,8 +92,6 @@ form:
|
||||
type: bool
|
||||
help: Ask the user confirmation when deleting a page
|
||||
|
||||
|
||||
|
||||
Popularity:
|
||||
type: section
|
||||
title: Popularity
|
||||
|
||||
@@ -21,8 +21,8 @@ en:
|
||||
FORGOT_EMAIL_BODY: <h1>Password Reset</h1><p>Dear %1$s,</p><p>A request was made on <b>%4$s</b> to reset your password.</p><p><br /><a href="%2$s" class="btn-primary">Click this to reset your password</a><br /><br /></p><p>Alternatively, copy the following URL into your browser's address bar:</p> <p>%2$s</p><p><br />Kind regards,<br /><br />%3$s</p>
|
||||
|
||||
it:
|
||||
ADMIN_BETA_MSG: This is a Beta release! Use this in production at your own risk...
|
||||
ADMIN_REPORT_ISSUE: Found an issue? Please report it on GitHub.
|
||||
ADMIN_BETA_MSG: Questa è una versione beta! Usare in produzione a proprio rischio e pericolo…
|
||||
ADMIN_REPORT_ISSUE: Trovato un problema? Per favore, apri un ticket su GitHub
|
||||
EMAIL_FOOTER: <a href="http://getgrav.org">Powered by Grav</a> - The Modern Flat File CMS
|
||||
LOGIN_BTN: Login
|
||||
LOGIN_BTN_FORGOT: Reset password
|
||||
|
||||
Reference in New Issue
Block a user