diff options
| -rw-r--r-- | README.md | 91 | ||||
| -rw-r--r-- | inc/config.php | 9 | ||||
| -rw-r--r-- | inc/instance-config.php | 19 |
3 files changed, 74 insertions, 45 deletions
@@ -1,45 +1,46 @@ -# Tinyboard - A lightweight PHP imageboard.
-
-## About
-Tinyboard is an imageboard software package written in PHP. It aims to maintain a stable, fast, clean and user-friendly engine for imageboards. Development for Tinyboard started in October 2010 and the project is being lead by [OmegaSDG][o] ("Omega Software Develop Group"). You can contact the development team over IRC at irc.n0v4.com #tinyboard.
-
-Tinyboard is not currently at a stable state.
-
-[o]: http://omegadev.org/
-
-## Installation
- 1. Tinyboard requires a MySQL database and a user to work. Create one.
- 2. Import 'install.sql' into the database. There are several ways to do this.
- - using phpMyAdmin
- - `mysql -uUSERNAME -pPASSWORD DATABASE < install.sql`
- 3. Edit '[inc/config.php][c]' to suit your installation
- 4. Make sure that the directories used by Tinyboard are writable. Depending on your setup, you may need to `chmod` the directories to 777.
- The default directories are:
- - ./res
- - ./src
- - ./thumb
- - . (document root)
- 5. Ensure everything is okay by running [test.php][t] in a browser. The script will try and help you correct your errors.
- 6. Run the [post.php][p] script. It should create an index.html and redirect you to it if everything is okay.
- 7. Optional (highly recommended): Either delete or chmod as unreadable the following files: [test.php][t], [install.sql][i], and this [README][r].
-
-[t]: http://github.com/savetheinternet/Tinyboard/blob/master/test.php
-[p]: http://github.com/savetheinternet/Tinyboard/blob/master/post.php
-[c]: http://github.com/savetheinternet/Tinyboard/blob/master/inc/config.php
-[i]: http://github.com/savetheinternet/Tinyboard/blob/master/install.sql
-[r]: http://github.com/savetheinternet/Tinyboard/blob/master/README.md
-
-## License
-Copyright (c) 2010 by Omega Software Development Group
-
-Permission to use, copy, modify, and/or distribute this software for any
-purpose with or without fee is hereby granted, provided that the above copyright
-notice and this permission notice appear in all copies.
-
-THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
-WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
-MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
-ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
-WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
-ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
-OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
\ No newline at end of file +# Tinyboard - A lightweight PHP imageboard. + +## About +Tinyboard is an imageboard software package written in PHP. It aims to maintain a stable, fast, clean and user-friendly engine for imageboards. Development for Tinyboard started in October 2010 and the project is being lead by [OmegaSDG][o] ("Omega Software Develop Group"). You can contact the development team over IRC at irc.n0v4.com #tinyboard. + +Tinyboard is not currently at a stable state. + +[o]: http://omegadev.org/ + +## Installation + 1. Tinyboard requires a MySQL database and a user to work. Create one. + 2. Import 'install.sql' into the database. There are several ways to do this. + - using phpMyAdmin + - `mysql -uUSERNAME -pPASSWORD DATABASE < install.sql` + 3. Create an 'instance-config.php'. It should be a PHP script that redefines some values in '[inc/config.php][c]' to suit your installation. + 4. Make sure that the directories used by Tinyboard are writable. Depending on your setup, you may need to `chmod` the directories to 777. + The default directories are: + - ./res + - ./src + - ./thumb + - . (document root) + 5. Ensure everything is okay by running [test.php][t] in a browser. The script will try and help you correct your errors. + 6. Run the [post.php][p] script. It should create an index.html and redirect you to it if everything is okay. + 7. Optional (highly recommended): Either delete or chmod as unreadable the following files: [test.php][t], [install.sql][i], and this [README][r]. + +[t]: http://github.com/savetheinternet/Tinyboard/blob/master/test.php +[p]: http://github.com/savetheinternet/Tinyboard/blob/master/post.php +[c]: http://github.com/savetheinternet/Tinyboard/blob/master/inc/config.php +[i]: http://github.com/savetheinternet/Tinyboard/blob/master/install.sql +[r]: http://github.com/savetheinternet/Tinyboard/blob/master/README.md + +## License +Copyright (c) 2010 by Omega Software Development Group + +Permission to use, copy, modify, and/or distribute this software for any +purpose with or without fee is hereby granted, provided that the above copyright +notice and this permission notice appear in all copies. + +THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES +WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF +MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR +ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES +WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN +ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF +OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. + diff --git a/inc/config.php b/inc/config.php index 43f4a449..ce005839 100644 --- a/inc/config.php +++ b/inc/config.php @@ -1,4 +1,13 @@ <?php + +/* + * WARNING: This is a project-wide configuration file shared by all Tinyboard users around the globe. + * If you would like to make instance-specific changes to your own setup, please use instance-config.php. + * + * This is the default configuration. You can copy values from here and use them in + * your instance-config.php + * + */ // Database stuff define('MY_SERVER', 'localhost', true); diff --git a/inc/instance-config.php b/inc/instance-config.php new file mode 100644 index 00000000..7655d344 --- /dev/null +++ b/inc/instance-config.php @@ -0,0 +1,19 @@ +<?php
+/*
+ * Instance Configuration
+ * ----------------------
+ * Edit this file and not config.php for imageboard configuration.
+ *
+ * You can copy values from config.php (defaults) and paste them here.
+ */
+
+ /*
+
+ define('MY_SERVER', 'localhost', true);
+ define('MY_USER', '', true);
+ define('MY_PASSWORD', '', true);
+ define('MY_DATABASE', '', true);
+
+// define('FOO', 'bar');
+ */
+?>
\ No newline at end of file |