Update README.md

This commit is contained in:
Sebastian Grewe 2013-05-24 08:57:08 +02:00
parent 1c5bd14646
commit 9cf193c539

102
README.md
View File

@ -63,102 +63,18 @@ The following feature have been implemented so far:
Installation Installation
============ ============
Please ensure you fullfill the minimal installation requirements listed above Please take a look at the [Quick Start Guide](https://github.com/TheSerapher/php-mmcfe-ng/wiki/Quick-Start-Guide). This will give you
and install any missing packages or software. an idea how to setup `mmcfe-ng`.
Download Source Contributing
--------------- ============
Download the (stable) master branch from Github: You can contribute to this project in different ways:
``` * Report outstanding issues and bugs by creating an [Issue][1]
git clone -b master git://github.com/TheSerapher/php-mmcfe-ng.git mmcfe-ng * Suggest feature enhancements also via [Issues][1]
``` * Fork the project, create a branch and file a pull request to improve the code itself
Or, if you are not using git, use the ZIP file provided:
```
wget https://github.com/TheSerapher/php-mmcfe-ng/archive/master.zip
unzip master.zip
mv php-mmcfe-ng-master mmcfe-ng
```
Permissions
-----------
Please ensure your webuser (e.g. `www-data`, `apache`) has write access to
the `mmcfe-ng/public/templates/compile` folder! Otherwise compiled
templates can not be stored:
```
sudo chown www-data mmcfe-ng/public/templates/compile
```
Apache2 Configuration
---------------------
Please point your website document root to the `mmcfe-ng/public` folder
and enable auto-index for `index.php`.
Memcache
--------
Please install and start a default memcache instance. Not only would you
need one for `pushpoold` but the statistics page is storing data in
`memcache` as well to improve performance. Your memcache can be
configured in the global configuration file (see below).
Configuration
-------------
Please create the `mmcfe-ng/public/include/config/global.inc.php`
configuration from the supplied template
`mmcfe-ng/public/include/config/global.inc.dist.php`.
Pushpoold
---------
Please ensure the passwords are read from the proper table by adding this to your configuration:
```
# database settings
"database" : {
"engine" : "mysql",
"port" : "3306",
"name" : "mmcfeng_database_name",
"username" : "someuser",
"password" : "somepass",
"sharelog" : true,
"stmt.pwdb":"SELECT `password` FROM `workers` WHERE `username` = ?",
"stmt.sharelog":"INSERT INTO shares (rem_host, username, our_result, upstream_result, reason, solution) VALUES (?, ?, ?, ?, ?, ?)"
},
```
Database
========
Now that the software is ready we need to import the database.
You will find the SQL file in the `mmcfe-ng/sql` folder.
Import this file into an existing database and you should
have the proper structure ready.
TODO
====
I tried to cover most features available in mmcFE. There might be some missing still
(like graphs, some stats) but if you figure there is a core function missing please let
me know by creating an [Issue][1] marked as `Feature Request`.
Disclaimer
==========
This is a **WIP Project**. Most functionality is now added, the core
features are available and the backend cronjobs are working. I would not recommend
running this on a live pool yet. You can play around and test basic functionality but
wait for any live deployment for at least a stable Release Candidate.
[1]: https://github.com/TheSerapher/php-mmcfe-ng/issues "Issue"
License and Author License and Author
================== ==================
@ -177,3 +93,5 @@ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and See the License for the specific language governing permissions and
limitations under the License. limitations under the License.
[1]: https://github.com/TheSerapher/php-mmcfe-ng/issues "Issue"