From 85c3f82ff3d99e13a758e16263e689740d9e43f7 Mon Sep 17 00:00:00 2001 From: Mikael Nordfeldth Date: Wed, 10 Dec 2014 21:26:23 +0100 Subject: [PATCH] Documentation updates Apparently we had two installation instructions, one of which were incomplete. --- HOW-TO-INSTALL-GNU-SOCIAL.txt | 37 ------------------ INSTALL | 71 +++++++++++------------------------ extlib/README | 52 ++++++++++++++++++++++++- 3 files changed, 72 insertions(+), 88 deletions(-) delete mode 100644 HOW-TO-INSTALL-GNU-SOCIAL.txt diff --git a/HOW-TO-INSTALL-GNU-SOCIAL.txt b/HOW-TO-INSTALL-GNU-SOCIAL.txt deleted file mode 100644 index 24fd0a0c78..0000000000 --- a/HOW-TO-INSTALL-GNU-SOCIAL.txt +++ /dev/null @@ -1,37 +0,0 @@ -## How to install GNU social - -There are two ways to install GNU social -- from git, or from a snapshot. - -### Install from git - -0. Make sure you have all the things you need installed: - - sudo locale-gen en_US en_US.UTF-8 - sudo dpkg-reconfigure locales - sudo apt-get update -q - sudo apt-get dist-upgrade -y - sudo apt-get install -y pound varnish php5 rsync htop emacs23-nox apache2 php5-mysql dtrx mysql-server exim4 - -1. SSH to your server - - ssh mattl@mattl.io - -2. Make a directory for your installation and let the webserver write to it. - - mkdir www/mattl.io -p - chown www-data:www-data www/mattl.io - -3. Check out GNU social into your directory. - - cd www/mattl.io - git clone git://gitorious.org/social/mainline.git . - -4. Make a database. - - mysql -u root -p - create database social; - exit - -5. Visit your website and enter your name, database details, etc. - -6. You're all set! diff --git a/INSTALL b/INSTALL index d1d5722e7b..3396486692 100644 --- a/INSTALL +++ b/INSTALL @@ -1,6 +1,25 @@ +TABLE OF CONTENTS +================= +* Prerequisites + - PHP modules + - Better performance +* Installation + - Getting it up and running + - Fancy URLs + - Sphinx + - SMS + - Queues and daemons + - Themes + - Translation + - Backups + - Private + Prerequisites ============= +PHP modules +----------- + The following software packages are *required* for this software to run correctly. @@ -55,54 +74,12 @@ your site's config.php with: addPlugin('XCache'); -External libraries ------------------- - -A number of external PHP libraries are used to provide basic -functionality and optional functionality for your system. For your -convenience, they are available in the "extlib" directory of this -package, and you do not have to download and install them. However, -you may want to keep them up-to-date with the latest upstream version, -and the URLs are listed here for your convenience. - -- DB_DataObject http://pear.php.net/package/DB_DataObject -- Validate http://pear.php.net/package/Validate -- OpenID by Janrain, http://janrain.com/openid-enabled/ -- PEAR DB. Although this is an older data access system (new - packages should use PDO), the OpenID libraries depend on PEAR DB - or MDB2. -- OAuth.php from http://oauth.googlecode.com/svn/code/php/ -- markdown.php from http://michelf.com/projects/php-markdown/ -- PEAR Mail, for sending out mail notifications - http://pear.php.net/package/Mail -- PEAR Net_SMTP, if you use the SMTP factory for notifications - http://pear.php.net/package/Net_SMTP -- PEAR Net_Socket, if you use the SMTP factory for notifications - http://pear.php.net/package/Net_Socket -- XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP - library available for PHP. http://xmpphp.googlecode.com/. Note that - as of this writing the version of this library that is available in - the extlib directory is *significantly different* from the upstream - version (patches have been submitted). Upgrading to the upstream - version may render your StatusNet site unable to send or receive XMPP - messages. -- Facebook library. Used for the Facebook application. -- PEAR Validate is used for URL and email validation. -- Console_GetOpt for parsing command-line options. - predecessor to OStatus. -- HTTP_Request2, a library for making HTTP requests. -- PEAR Net_URL2 is an HTTP_Request2 dependency. - -A design goal of GNU Social is that the basic Web functionality should -work on even the most restrictive commercial hosting services. -However, additional functionality, such as receiving messages by XMPP, -require that you be able to run long-running processes on your account. -In addition, posting by email require that you be able to install a mail -filter in your mail server. - Installation ============ +Getting it up and running +------------------------- + Installing the basic GNU Social web component is relatively easy, especially if you've previously installed PHP/MariaDB packages. @@ -310,10 +287,6 @@ For this to work, there *must* be a domain or sub-domain for which all $config['mail']['domain'] = 'yourdomain.example.net'; -At this point, post-by-email and post-by-SMS-gateway should work. Note -that if your mail server is on a different computer from your email -server, you'll need to have a full installation of StatusNet, a working -config.php, and access to the StatusNet database from the mail server. Queues and daemons diff --git a/extlib/README b/extlib/README index e62cb9960f..83ca7cec6c 100644 --- a/extlib/README +++ b/extlib/README @@ -16,7 +16,8 @@ Forking upstream software for trivial reasons makes us bad citizens in the Open Source community and adds unnecessary heartache for our users. Don't make us "that" project. -FAQ: +Frequently Asked Questions +-------------------------- Q: What should we do when we find a bug in upstream software? @@ -45,7 +46,7 @@ Q: I tried again, and upstream is still unresponsive and nobody's checked on my patch. Now what? A: If the upstream project is moribund and there's a way to adopt it, - propose having the StatusNet dev team adopt the project. Or, adopt + propose having the GNU social dev team adopt the project. Or, adopt it yourself. Q: What if there's no upstream authority and it can't be adopted? @@ -56,3 +57,50 @@ A: Then we fork it. Make a new name and a new version. Include it in This is a last resort; consult with the rest of the dev group before taking this radical step. + +List of external libraries +-------------------------- + +A number of external PHP libraries are used to provide basic +functionality and optional functionality for your system. For your +convenience, they are available in the "extlib" directory of this +package, and you do not have to download and install them. However, +you may want to keep them up-to-date with the latest upstream version, +and the URLs are listed here for your convenience. + +- DB_DataObject http://pear.php.net/package/DB_DataObject +- Validate http://pear.php.net/package/Validate +- OpenID by Janrain, http://janrain.com/openid-enabled/ +- PEAR DB. Although this is an older data access system (new + packages should use PDO), the OpenID libraries depend on PEAR DB + or MDB2. +- OAuth.php from http://oauth.googlecode.com/svn/code/php/ + (has been edited to avoid colliding autoload) +- markdown.php from http://michelf.com/projects/php-markdown/ +- PEAR Mail, for sending out mail notifications + http://pear.php.net/package/Mail +- PEAR Net_SMTP, if you use the SMTP factory for notifications + http://pear.php.net/package/Net_SMTP +- PEAR Net_Socket, if you use the SMTP factory for notifications + http://pear.php.net/package/Net_Socket +- XMPPHP, the follow-up to Class.Jabber.php. Probably the best XMPP + library available for PHP. http://xmpphp.googlecode.com/. Note that + as of this writing the version of this library that is available in + the extlib directory is *significantly different* from the upstream + version (patches have been submitted). Upgrading to the upstream + version may render your GNU social site unable to send or receive XMPP + messages. +- Facebook library. Used for the Facebook application. +- PEAR Validate is used for URL and email validation. +- Console_GetOpt for parsing command-line options. +- HTTP_Request2, a library for making HTTP requests. +- PEAR Net_URL2 is an HTTP_Request2 dependency. +- Michelf/Markdown.php Markdown parser library +- Mf2/Parser.php microformats2 parser library + +A design goal of GNU Social is that the basic Web functionality should +work on even the most restrictive commercial hosting services. +However, additional functionality, such as receiving messages by XMPP, +require that you be able to run long-running processes on your account. +In addition, posting by email require that you be able to install a mail +filter in your mail server. -- 2.39.5