aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--README.md21
-rw-r--r--classes/Constants.php2
2 files changed, 15 insertions, 8 deletions
diff --git a/README.md b/README.md
index 4b1cd95..6409485 100644
--- a/README.md
+++ b/README.md
@@ -3,7 +3,8 @@ Administration software for small companies
BusinessAdmin is a web-based administration application that helps you, the
owner of a small business, keep track of your current projects and clients. It
-features a built-in **PDF invoice generator**.
+features a built-in **PDF invoice generator**, **mailer** and a connection to
+**Braintree** to handle electronic payments.
Its intuitive interface lets you use it efficiently from the start. See the
Usage section below.
@@ -30,6 +31,9 @@ git clone --recursive https://github.com/camilstaps/BusinessAdmin.git
In the appropriate location block.
+* For privacy reasons, the `files/` directory should be denied access from all
+ users except the PHP user, and not be accessible from outside.
+
* Naturally, you should have your server configured to run PHP files with a PHP
backend.
@@ -37,8 +41,7 @@ git clone --recursive https://github.com/camilstaps/BusinessAdmin.git
BusinessAdmin assumes a MySQL database is setup properly. This can be:
-* A dedicated database only used for BusinessAdmin
-
+* A dedicated database only used for BusinessAdmin.
* A database used with other projects as well. BusinessAdmin can use table
prefixes, if you configure it to do so.
@@ -46,10 +49,11 @@ BusinessAdmin assumes a MySQL database is setup properly. This can be:
There are two files concerned when setting the configuration options.
-In conf.private.php you can enter your MySQL details (host, database, username,
-password, server port). You can use conf.private.example.php as an example.
+In conf.private.php you can enter several settings for the database, sending
+emails and linking to Braintree. You can use conf.private.example.php as an
+example.
-In classes/constants.php, you should at least set the following options:
+In classes/Constants.php, you should at least set the following options:
* `db_prefix`: set if you'd like BusinessAdmin to use table prefixes in the
database. For example, with the prefix `ba_`, tables will get names like
@@ -88,7 +92,9 @@ You need to deny any requests for any files in the /files folder.
## Permissions
The files folder will be used to put generated invoices in. Make your server
-user (usually `www-data`) full permissions to this folder.
+user (usually `www-data`) full permissions to this folder. For privacy reasons,
+don't give other users access to this directory. Also, don't let it be
+accessible from outside.
## Personalizing
@@ -172,6 +178,7 @@ are listed by name and removal time. This way, you never really lose your file.
### 0.5 (Jul 28, 2016)
+0.5.3 Frontend updates.
0.5.2 Emails.
0.5.1 Files are hidden from the world.
0.5 Braintree integration.
diff --git a/classes/Constants.php b/classes/Constants.php
index 7528630..a4f3532 100644
--- a/classes/Constants.php
+++ b/classes/Constants.php
@@ -78,5 +78,5 @@ class Constants {
const password_cost = 10;
/** @const version Version of BusinessAdmin. Don't change this yourself! */
- const version = '0.5.2';
+ const version = '0.5.3';
}