Make indenting consistent in README
This commit is contained in:
Zach Copley
parent
e6f379f8a3
commit
fc3b53853f
516
README
516
README
|
|
@ -35,7 +35,7 @@ Identi.ca <http://identi.ca/>. It is shared with you in hope that you
|
||||||
too make an Open Software Service available to your users. To learn
|
too make an Open Software Service available to your users. To learn
|
||||||
more, please see the Open Software Service Definition 1.1:
|
more, please see the Open Software Service Definition 1.1:
|
||||||
|
|
||||||
http://www.opendefinition.org/ossd
|
http://www.opendefinition.org/ossd
|
||||||
|
|
||||||
StatusNet, Inc. <http://status.net/> also offers this software as a
|
StatusNet, Inc. <http://status.net/> also offers this software as a
|
||||||
Web service, requiring no installation on your part. The software run
|
Web service, requiring no installation on your part. The software run
|
||||||
|
|
@ -254,11 +254,11 @@ especially if you've previously installed PHP/MySQL packages.
|
||||||
|
|
||||||
3. Make your target directory writeable by the Web server.
|
3. Make your target directory writeable by the Web server.
|
||||||
|
|
||||||
chmod a+w /var/www/statusnet/
|
chmod a+w /var/www/statusnet/
|
||||||
|
|
||||||
On some systems, this will probably work:
|
On some systems, this will probably work:
|
||||||
|
|
||||||
chgrp www-data /var/www/statusnet/
|
chgrp www-data /var/www/statusnet/
|
||||||
chmod g+w /var/www/statusnet/
|
chmod g+w /var/www/statusnet/
|
||||||
|
|
||||||
If your Web server runs as another user besides "www-data", try
|
If your Web server runs as another user besides "www-data", try
|
||||||
|
|
@ -269,9 +269,9 @@ especially if you've previously installed PHP/MySQL packages.
|
||||||
file subdirectories writeable by the Web server. An insecure way to do
|
file subdirectories writeable by the Web server. An insecure way to do
|
||||||
this is:
|
this is:
|
||||||
|
|
||||||
chmod a+w /var/www/statusnet/avatar
|
chmod a+w /var/www/statusnet/avatar
|
||||||
chmod a+w /var/www/statusnet/background
|
chmod a+w /var/www/statusnet/background
|
||||||
chmod a+w /var/www/statusnet/file
|
chmod a+w /var/www/statusnet/file
|
||||||
|
|
||||||
You can also make the avatar, background, and file directories
|
You can also make the avatar, background, and file directories
|
||||||
writeable by the Web server group, as noted above.
|
writeable by the Web server group, as noted above.
|
||||||
|
|
@ -279,7 +279,7 @@ especially if you've previously installed PHP/MySQL packages.
|
||||||
5. Create a database to hold your microblog data. Something like this
|
5. Create a database to hold your microblog data. Something like this
|
||||||
should work:
|
should work:
|
||||||
|
|
||||||
mysqladmin -u "username" --password="password" create statusnet
|
mysqladmin -u "username" --password="password" create statusnet
|
||||||
|
|
||||||
Note that StatusNet must have its own database; you can't share the
|
Note that StatusNet must have its own database; you can't share the
|
||||||
database with another program. You can name it whatever you want,
|
database with another program. You can name it whatever you want,
|
||||||
|
|
@ -293,9 +293,9 @@ especially if you've previously installed PHP/MySQL packages.
|
||||||
database. If you have shell access, this will probably work from the
|
database. If you have shell access, this will probably work from the
|
||||||
MySQL shell:
|
MySQL shell:
|
||||||
|
|
||||||
GRANT ALL on statusnet.*
|
GRANT ALL on statusnet.*
|
||||||
TO 'statusnetuser'@'localhost'
|
TO 'statusnetuser'@'localhost'
|
||||||
IDENTIFIED BY 'statusnetpassword';
|
IDENTIFIED BY 'statusnetpassword';
|
||||||
|
|
||||||
You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
|
You should change 'statusnetuser' and 'statusnetpassword' to your preferred new
|
||||||
username and password. You may want to test logging in to MySQL as
|
username and password. You may want to test logging in to MySQL as
|
||||||
|
|
@ -303,7 +303,7 @@ especially if you've previously installed PHP/MySQL packages.
|
||||||
|
|
||||||
7. In a browser, navigate to the StatusNet install script; something like:
|
7. In a browser, navigate to the StatusNet install script; something like:
|
||||||
|
|
||||||
http://yourserver.example.com/statusnet/install.php
|
http://yourserver.example.com/statusnet/install.php
|
||||||
|
|
||||||
Enter the database connection information and your site name. The
|
Enter the database connection information and your site name. The
|
||||||
install program will configure your site and install the initial,
|
install program will configure your site and install the initial,
|
||||||
|
|
@ -357,7 +357,7 @@ your server.
|
||||||
You should now be able to navigate to a "fancy" URL on your server,
|
You should now be able to navigate to a "fancy" URL on your server,
|
||||||
like:
|
like:
|
||||||
|
|
||||||
http://example.net/statusnet/main/register
|
http://example.net/statusnet/main/register
|
||||||
|
|
||||||
If you changed your HTTP server configuration, you may need to restart
|
If you changed your HTTP server configuration, you may need to restart
|
||||||
the server first.
|
the server first.
|
||||||
|
|
@ -368,11 +368,11 @@ directory is 'All' in your Apache configuration file. This is usually
|
||||||
/etc/apache2/sites-available/default. See the Apache documentation for
|
/etc/apache2/sites-available/default. See the Apache documentation for
|
||||||
.htaccess files for more details:
|
.htaccess files for more details:
|
||||||
|
|
||||||
http://httpd.apache.org/docs/2.2/howto/htaccess.html
|
http://httpd.apache.org/docs/2.2/howto/htaccess.html
|
||||||
|
|
||||||
Also, check that mod_rewrite is installed and enabled:
|
Also, check that mod_rewrite is installed and enabled:
|
||||||
|
|
||||||
http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
|
http://httpd.apache.org/docs/2.2/mod/mod_rewrite.html
|
||||||
|
|
||||||
Sphinx
|
Sphinx
|
||||||
------
|
------
|
||||||
|
|
@ -380,8 +380,8 @@ Sphinx
|
||||||
To use a Sphinx server to search users and notices, you'll need to
|
To use a Sphinx server to search users and notices, you'll need to
|
||||||
enable the SphinxSearch plugin. Add to your config.php:
|
enable the SphinxSearch plugin. Add to your config.php:
|
||||||
|
|
||||||
addPlugin('SphinxSearch');
|
addPlugin('SphinxSearch');
|
||||||
$config['sphinx']['server'] = 'searchhost.local';
|
$config['sphinx']['server'] = 'searchhost.local';
|
||||||
|
|
||||||
You also need to install, compile and enable the sphinx pecl extension for
|
You also need to install, compile and enable the sphinx pecl extension for
|
||||||
php on the client side, which itself depends on the sphinx development files.
|
php on the client side, which itself depends on the sphinx development files.
|
||||||
|
|
@ -416,26 +416,26 @@ For this to work, there *must* be a domain or sub-domain for which all
|
||||||
|
|
||||||
2. Make sure the maildaemon.php file is executable:
|
2. Make sure the maildaemon.php file is executable:
|
||||||
|
|
||||||
chmod +x scripts/maildaemon.php
|
chmod +x scripts/maildaemon.php
|
||||||
|
|
||||||
Note that "daemon" is kind of a misnomer here; the script is more
|
Note that "daemon" is kind of a misnomer here; the script is more
|
||||||
of a filter than a daemon.
|
of a filter than a daemon.
|
||||||
|
|
||||||
2. Edit /etc/aliases on your mail server and add the following line:
|
2. Edit /etc/aliases on your mail server and add the following line:
|
||||||
|
|
||||||
*: /path/to/statusnet/scripts/maildaemon.php
|
*: /path/to/statusnet/scripts/maildaemon.php
|
||||||
|
|
||||||
3. Run whatever code you need to to update your aliases database. For
|
3. Run whatever code you need to to update your aliases database. For
|
||||||
many mail servers (Postfix, Exim, Sendmail), this should work:
|
many mail servers (Postfix, Exim, Sendmail), this should work:
|
||||||
|
|
||||||
newaliases
|
newaliases
|
||||||
|
|
||||||
You may need to restart your mail server for the new database to
|
You may need to restart your mail server for the new database to
|
||||||
take effect.
|
take effect.
|
||||||
|
|
||||||
4. Set the following in your config.php file:
|
4. Set the following in your config.php file:
|
||||||
|
|
||||||
$config['mail']['domain'] = 'yourdomain.example.net';
|
$config['mail']['domain'] = 'yourdomain.example.net';
|
||||||
|
|
||||||
At this point, post-by-email and post-by-SMS-gateway should work. Note
|
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
|
that if your mail server is on a different computer from your email
|
||||||
|
|
@ -489,7 +489,7 @@ search, indexing, bridging, or other cool services.
|
||||||
To configure a downstream site to receive your public stream, add
|
To configure a downstream site to receive your public stream, add
|
||||||
their "JID" (Jabber ID) to your config.php as follows:
|
their "JID" (Jabber ID) to your config.php as follows:
|
||||||
|
|
||||||
$config['xmpp']['public'][] = 'downstream@example.net';
|
$config['xmpp']['public'][] = 'downstream@example.net';
|
||||||
|
|
||||||
(Don't miss those square brackets at the end.) Note that your XMPP
|
(Don't miss those square brackets at the end.) Note that your XMPP
|
||||||
broadcasting must be configured as mentioned above. Although you can
|
broadcasting must be configured as mentioned above. Although you can
|
||||||
|
|
@ -518,7 +518,7 @@ server is probably a good idea for high-volume sites.
|
||||||
3. In your config.php files (both the Web server and the queues
|
3. In your config.php files (both the Web server and the queues
|
||||||
server!), set the following variable:
|
server!), set the following variable:
|
||||||
|
|
||||||
$config['queue']['enabled'] = true;
|
$config['queue']['enabled'] = true;
|
||||||
|
|
||||||
You may also want to look at the 'daemon' section of this file for
|
You may also want to look at the 'daemon' section of this file for
|
||||||
more daemon options. Note that if you set the 'user' and/or 'group'
|
more daemon options. Note that if you set the 'user' and/or 'group'
|
||||||
|
|
@ -577,15 +577,15 @@ following files:
|
||||||
|
|
||||||
display.css: a CSS2 file for "default" styling for all browsers.
|
display.css: a CSS2 file for "default" styling for all browsers.
|
||||||
ie6.css: a CSS2 file for override styling for fixing up Internet
|
ie6.css: a CSS2 file for override styling for fixing up Internet
|
||||||
Explorer 6.
|
Explorer 6.
|
||||||
ie7.css: a CSS2 file for override styling for fixing up Internet
|
ie7.css: a CSS2 file for override styling for fixing up Internet
|
||||||
Explorer 7.
|
Explorer 7.
|
||||||
logo.png: a logo image for the site.
|
logo.png: a logo image for the site.
|
||||||
default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
|
default-avatar-profile.png: a 96x96 pixel image to use as the avatar for
|
||||||
users who don't upload their own.
|
users who don't upload their own.
|
||||||
default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
|
default-avatar-stream.png: Ditto, but 48x48. For streams of notices.
|
||||||
default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
|
default-avatar-mini.png: Ditto ditto, but 24x24. For subscriptions
|
||||||
listing on profile pages.
|
listing on profile pages.
|
||||||
|
|
||||||
You may want to start by copying the files from the default theme to
|
You may want to start by copying the files from the default theme to
|
||||||
your own directory.
|
your own directory.
|
||||||
|
|
@ -634,17 +634,17 @@ Access to file attachments can also be restricted to logged-in users only.
|
||||||
1. Add a directory outside the web root where your file uploads will be
|
1. Add a directory outside the web root where your file uploads will be
|
||||||
stored. Usually a command like this will work:
|
stored. Usually a command like this will work:
|
||||||
|
|
||||||
mkdir /var/www/statusnet-files
|
mkdir /var/www/statusnet-files
|
||||||
|
|
||||||
2. Make the file uploads directory writeable by the web server. An
|
2. Make the file uploads directory writeable by the web server. An
|
||||||
insecure way to do this is:
|
insecure way to do this is:
|
||||||
|
|
||||||
chmod a+x /var/www/statusnet-files
|
chmod a+x /var/www/statusnet-files
|
||||||
|
|
||||||
3. Tell StatusNet to use this directory for file uploads. Add a line
|
3. Tell StatusNet to use this directory for file uploads. Add a line
|
||||||
like this to your config.php:
|
like this to your config.php:
|
||||||
|
|
||||||
$config['attachments']['dir'] = '/var/www/statusnet-files';
|
$config['attachments']['dir'] = '/var/www/statusnet-files';
|
||||||
|
|
||||||
Upgrading
|
Upgrading
|
||||||
=========
|
=========
|
||||||
|
|
@ -696,12 +696,12 @@ instructions; read to the end first before trying them.
|
||||||
If your database is at version 0.8.0 or above, you can run a
|
If your database is at version 0.8.0 or above, you can run a
|
||||||
special upgrade script:
|
special upgrade script:
|
||||||
|
|
||||||
mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
|
mysql -u<rootuser> -p<rootpassword> <database> db/08to09.sql
|
||||||
|
|
||||||
Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
|
Otherwise, go to your StatusNet directory and AFTER YOU MAKE A
|
||||||
BACKUP run the rebuilddb.sh script like this:
|
BACKUP run the rebuilddb.sh script like this:
|
||||||
|
|
||||||
./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
|
./scripts/rebuilddb.sh rootuser rootpassword database db/statusnet.sql
|
||||||
|
|
||||||
Here, rootuser and rootpassword are the username and password for a
|
Here, rootuser and rootpassword are the username and password for a
|
||||||
user who can drop and create databases as well as tables; typically
|
user who can drop and create databases as well as tables; typically
|
||||||
|
|
@ -785,7 +785,7 @@ Almost all configuration options are made through a two-dimensional
|
||||||
associative array, cleverly named $config. A typical configuration
|
associative array, cleverly named $config. A typical configuration
|
||||||
line will be:
|
line will be:
|
||||||
|
|
||||||
$config['section']['option'] = value;
|
$config['section']['option'] = value;
|
||||||
|
|
||||||
For brevity, the following documentation describes each section and
|
For brevity, the following documentation describes each section and
|
||||||
option.
|
option.
|
||||||
|
|
@ -798,78 +798,78 @@ This section is a catch-all for site-wide variables.
|
||||||
name: the name of your site, like 'YourCompany Microblog'.
|
name: the name of your site, like 'YourCompany Microblog'.
|
||||||
server: the server part of your site's URLs, like 'example.net'.
|
server: the server part of your site's URLs, like 'example.net'.
|
||||||
path: The path part of your site's URLs, like 'statusnet' or ''
|
path: The path part of your site's URLs, like 'statusnet' or ''
|
||||||
(installed in root).
|
(installed in root).
|
||||||
fancy: whether or not your site uses fancy URLs (see Fancy URLs
|
fancy: whether or not your site uses fancy URLs (see Fancy URLs
|
||||||
section above). Default is false.
|
section above). Default is false.
|
||||||
logfile: full path to a file for StatusNet to save logging
|
logfile: full path to a file for StatusNet to save logging
|
||||||
information to. You may want to use this if you don't have
|
information to. You may want to use this if you don't have
|
||||||
access to syslog.
|
access to syslog.
|
||||||
logdebug: whether to log additional debug info like backtraces on
|
logdebug: whether to log additional debug info like backtraces on
|
||||||
hard errors. Default false.
|
hard errors. Default false.
|
||||||
locale_path: full path to the directory for locale data. Unless you
|
locale_path: full path to the directory for locale data. Unless you
|
||||||
store all your locale data in one place, you probably
|
store all your locale data in one place, you probably
|
||||||
don't need to use this.
|
don't need to use this.
|
||||||
language: default language for your site. Defaults to US English.
|
language: default language for your site. Defaults to US English.
|
||||||
Note that this is overridden if a user is logged in and has
|
Note that this is overridden if a user is logged in and has
|
||||||
selected a different language. It is also overridden if the
|
selected a different language. It is also overridden if the
|
||||||
user is NOT logged in, but their browser requests a different
|
user is NOT logged in, but their browser requests a different
|
||||||
langauge. Since pretty much everybody's browser requests a
|
langauge. Since pretty much everybody's browser requests a
|
||||||
language, that means that changing this setting has little or
|
language, that means that changing this setting has little or
|
||||||
no effect in practice.
|
no effect in practice.
|
||||||
languages: A list of languages supported on your site. Typically you'd
|
languages: A list of languages supported on your site. Typically you'd
|
||||||
only change this if you wanted to disable support for one
|
only change this if you wanted to disable support for one
|
||||||
or another language:
|
or another language:
|
||||||
"unset($config['site']['languages']['de'])" will disable
|
"unset($config['site']['languages']['de'])" will disable
|
||||||
support for German.
|
support for German.
|
||||||
theme: Theme for your site (see Theme section). Two themes are
|
theme: Theme for your site (see Theme section). Two themes are
|
||||||
provided by default: 'default' and 'stoica' (the one used by
|
provided by default: 'default' and 'stoica' (the one used by
|
||||||
Identi.ca). It's appreciated if you don't use the 'stoica' theme
|
Identi.ca). It's appreciated if you don't use the 'stoica' theme
|
||||||
except as the basis for your own.
|
except as the basis for your own.
|
||||||
email: contact email address for your site. By default, it's extracted
|
email: contact email address for your site. By default, it's extracted
|
||||||
from your Web server environment; you may want to customize it.
|
from your Web server environment; you may want to customize it.
|
||||||
broughtbyurl: name of an organization or individual who provides the
|
broughtbyurl: name of an organization or individual who provides the
|
||||||
service. Each page will include a link to this name in the
|
service. Each page will include a link to this name in the
|
||||||
footer. A good way to link to the blog, forum, wiki,
|
footer. A good way to link to the blog, forum, wiki,
|
||||||
corporate portal, or whoever is making the service available.
|
corporate portal, or whoever is making the service available.
|
||||||
broughtby: text used for the "brought by" link.
|
broughtby: text used for the "brought by" link.
|
||||||
timezone: default timezone for message display. Users can set their
|
timezone: default timezone for message display. Users can set their
|
||||||
own time zone. Defaults to 'UTC', which is a pretty good default.
|
own time zone. Defaults to 'UTC', which is a pretty good default.
|
||||||
closed: If set to 'true', will disallow registration on your site.
|
closed: If set to 'true', will disallow registration on your site.
|
||||||
This is a cheap way to restrict accounts to only one
|
This is a cheap way to restrict accounts to only one
|
||||||
individual or group; just register the accounts you want on
|
individual or group; just register the accounts you want on
|
||||||
the service, *then* set this variable to 'true'.
|
the service, *then* set this variable to 'true'.
|
||||||
inviteonly: If set to 'true', will only allow registration if the user
|
inviteonly: If set to 'true', will only allow registration if the user
|
||||||
was invited by an existing user.
|
was invited by an existing user.
|
||||||
private: If set to 'true', anonymous users will be redirected to the
|
private: If set to 'true', anonymous users will be redirected to the
|
||||||
'login' page. Also, API methods that normally require no
|
'login' page. Also, API methods that normally require no
|
||||||
authentication will require it. Note that this does not turn
|
authentication will require it. Note that this does not turn
|
||||||
off registration; use 'closed' or 'inviteonly' for the
|
off registration; use 'closed' or 'inviteonly' for the
|
||||||
behaviour you want.
|
behaviour you want.
|
||||||
notice: A plain string that will appear on every page. A good place
|
notice: A plain string that will appear on every page. A good place
|
||||||
to put introductory information about your service, or info about
|
to put introductory information about your service, or info about
|
||||||
upgrades and outages, or other community info. Any HTML will
|
upgrades and outages, or other community info. Any HTML will
|
||||||
be escaped.
|
be escaped.
|
||||||
logo: URL of an image file to use as the logo for the site. Overrides
|
logo: URL of an image file to use as the logo for the site. Overrides
|
||||||
the logo in the theme, if any.
|
the logo in the theme, if any.
|
||||||
ssl: Whether to use SSL and https:// URLs for some or all pages.
|
ssl: Whether to use SSL and https:// URLs for some or all pages.
|
||||||
Possible values are 'always' (use it for all pages), 'never'
|
Possible values are 'always' (use it for all pages), 'never'
|
||||||
(don't use it for any pages), or 'sometimes' (use it for
|
(don't use it for any pages), or 'sometimes' (use it for
|
||||||
sensitive pages that include passwords like login and registration,
|
sensitive pages that include passwords like login and registration,
|
||||||
but not for regular pages). Default to 'never'.
|
but not for regular pages). Default to 'never'.
|
||||||
sslserver: use an alternate server name for SSL URLs, like
|
sslserver: use an alternate server name for SSL URLs, like
|
||||||
'secure.example.org'. You should be careful to set cookie
|
'secure.example.org'. You should be careful to set cookie
|
||||||
parameters correctly so that both the SSL server and the
|
parameters correctly so that both the SSL server and the
|
||||||
"normal" server can access the session cookie and
|
"normal" server can access the session cookie and
|
||||||
preferably other cookies as well.
|
preferably other cookies as well.
|
||||||
shorturllength: Length of URL at which URLs in a message exceeding 140
|
shorturllength: Length of URL at which URLs in a message exceeding 140
|
||||||
characters will be sent to the user's chosen
|
characters will be sent to the user's chosen
|
||||||
shortening service.
|
shortening service.
|
||||||
dupelimit: minimum time allowed for one person to say the same thing
|
dupelimit: minimum time allowed for one person to say the same thing
|
||||||
twice. Default 60s. Anything lower is considered a user
|
twice. Default 60s. Anything lower is considered a user
|
||||||
or UI error.
|
or UI error.
|
||||||
textlimit: default max size for texts in the site. Defaults to 140.
|
textlimit: default max size for texts in the site. Defaults to 140.
|
||||||
0 means no limit. Can be fine-tuned for notices, messages,
|
0 means no limit. Can be fine-tuned for notices, messages,
|
||||||
profile bios and group descriptions.
|
profile bios and group descriptions.
|
||||||
|
|
||||||
db
|
db
|
||||||
--
|
--
|
||||||
|
|
@ -879,24 +879,24 @@ DB_DataObject (see <http://ur1.ca/7xp>). The ones that you may want to
|
||||||
set are listed below for clarity.
|
set are listed below for clarity.
|
||||||
|
|
||||||
database: a DSN (Data Source Name) for your StatusNet database. This is
|
database: a DSN (Data Source Name) for your StatusNet database. This is
|
||||||
in the format 'protocol://username:password@hostname/databasename',
|
in the format 'protocol://username:password@hostname/databasename',
|
||||||
where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
|
where 'protocol' is 'mysql' or 'mysqli' (or possibly 'postgresql', if you
|
||||||
really know what you're doing), 'username' is the username,
|
really know what you're doing), 'username' is the username,
|
||||||
'password' is the password, and etc.
|
'password' is the password, and etc.
|
||||||
ini_yourdbname: if your database is not named 'statusnet', you'll need
|
ini_yourdbname: if your database is not named 'statusnet', you'll need
|
||||||
to set this to point to the location of the
|
to set this to point to the location of the
|
||||||
statusnet.ini file. Note that the real name of your database
|
statusnet.ini file. Note that the real name of your database
|
||||||
should go in there, not literally 'yourdbname'.
|
should go in there, not literally 'yourdbname'.
|
||||||
db_driver: You can try changing this to 'MDB2' to use the other driver
|
db_driver: You can try changing this to 'MDB2' to use the other driver
|
||||||
type for DB_DataObject, but note that it breaks the OpenID
|
type for DB_DataObject, but note that it breaks the OpenID
|
||||||
libraries, which only support PEAR::DB.
|
libraries, which only support PEAR::DB.
|
||||||
debug: On a database error, you may get a message saying to set this
|
debug: On a database error, you may get a message saying to set this
|
||||||
value to 5 to see debug messages in the browser. This breaks
|
value to 5 to see debug messages in the browser. This breaks
|
||||||
just about all pages, and will also expose the username and
|
just about all pages, and will also expose the username and
|
||||||
password
|
password
|
||||||
quote_identifiers: Set this to true if you're using postgresql.
|
quote_identifiers: Set this to true if you're using postgresql.
|
||||||
type: either 'mysql' or 'postgresql' (used for some bits of
|
type: either 'mysql' or 'postgresql' (used for some bits of
|
||||||
database-type-specific SQL in the code). Defaults to mysql.
|
database-type-specific SQL in the code). Defaults to mysql.
|
||||||
mirror: you can set this to an array of DSNs, like the above
|
mirror: you can set this to an array of DSNs, like the above
|
||||||
'database' value. If it's set, certain read-only actions will
|
'database' value. If it's set, certain read-only actions will
|
||||||
use a random value out of this array for the database, rather
|
use a random value out of this array for the database, rather
|
||||||
|
|
@ -906,17 +906,17 @@ mirror: you can set this to an array of DSNs, like the above
|
||||||
requests to go to the 'database' (master) server, you'll need
|
requests to go to the 'database' (master) server, you'll need
|
||||||
to include it in this array, too.
|
to include it in this array, too.
|
||||||
utf8: whether to talk to the database in UTF-8 mode. This is the default
|
utf8: whether to talk to the database in UTF-8 mode. This is the default
|
||||||
with new installations, but older sites may want to turn it off
|
with new installations, but older sites may want to turn it off
|
||||||
until they get their databases fixed up. See "UTF-8 database"
|
until they get their databases fixed up. See "UTF-8 database"
|
||||||
above for details.
|
above for details.
|
||||||
schemacheck: when to let plugins check the database schema to add
|
schemacheck: when to let plugins check the database schema to add
|
||||||
tables or update them. Values can be 'runtime' (default)
|
tables or update them. Values can be 'runtime' (default)
|
||||||
or 'script'. 'runtime' can be costly (plugins check the
|
or 'script'. 'runtime' can be costly (plugins check the
|
||||||
schema on every hit, adding potentially several db
|
schema on every hit, adding potentially several db
|
||||||
queries, some quite long), but not everyone knows how to
|
queries, some quite long), but not everyone knows how to
|
||||||
run a script. If you can, set this to 'script' and run
|
run a script. If you can, set this to 'script' and run
|
||||||
scripts/checkschema.php whenever you install or upgrade a
|
scripts/checkschema.php whenever you install or upgrade a
|
||||||
plugin.
|
plugin.
|
||||||
|
|
||||||
syslog
|
syslog
|
||||||
------
|
------
|
||||||
|
|
@ -925,13 +925,13 @@ By default, StatusNet sites log error messages to the syslog facility.
|
||||||
(You can override this using the 'logfile' parameter described above).
|
(You can override this using the 'logfile' parameter described above).
|
||||||
|
|
||||||
appname: The name that StatusNet uses to log messages. By default it's
|
appname: The name that StatusNet uses to log messages. By default it's
|
||||||
"statusnet", but if you have more than one installation on the
|
"statusnet", but if you have more than one installation on the
|
||||||
server, you may want to change the name for each instance so
|
server, you may want to change the name for each instance so
|
||||||
you can track log messages more easily.
|
you can track log messages more easily.
|
||||||
priority: level to log at. Currently ignored.
|
priority: level to log at. Currently ignored.
|
||||||
facility: what syslog facility to used. Defaults to LOG_USER, only
|
facility: what syslog facility to used. Defaults to LOG_USER, only
|
||||||
reset if you know what syslog is and have a good reason
|
reset if you know what syslog is and have a good reason
|
||||||
to change it.
|
to change it.
|
||||||
|
|
||||||
queue
|
queue
|
||||||
-----
|
-----
|
||||||
|
|
@ -942,51 +942,51 @@ sending out SMS email or XMPP messages, for off-line processing. See
|
||||||
|
|
||||||
enabled: Whether to uses queues. Defaults to false.
|
enabled: Whether to uses queues. Defaults to false.
|
||||||
subsystem: Which kind of queueserver to use. Values include "db" for
|
subsystem: Which kind of queueserver to use. Values include "db" for
|
||||||
our hacked-together database queuing (no other server
|
our hacked-together database queuing (no other server
|
||||||
required) and "stomp" for a stomp server.
|
required) and "stomp" for a stomp server.
|
||||||
stomp_server: "broker URI" for stomp server. Something like
|
stomp_server: "broker URI" for stomp server. Something like
|
||||||
"tcp://hostname:61613". More complicated ones are
|
"tcp://hostname:61613". More complicated ones are
|
||||||
possible; see your stomp server's documentation for
|
possible; see your stomp server's documentation for
|
||||||
details.
|
details.
|
||||||
queue_basename: a root name to use for queues (stomp only). Typically
|
queue_basename: a root name to use for queues (stomp only). Typically
|
||||||
something like '/queue/sitename/' makes sense. If running
|
something like '/queue/sitename/' makes sense. If running
|
||||||
multiple instances on the same server, make sure that
|
multiple instances on the same server, make sure that
|
||||||
either this setting or $config['site']['nickname'] are
|
either this setting or $config['site']['nickname'] are
|
||||||
unique for each site to keep them separate.
|
unique for each site to keep them separate.
|
||||||
|
|
||||||
stomp_username: username for connecting to the stomp server; defaults
|
stomp_username: username for connecting to the stomp server; defaults
|
||||||
to null.
|
to null.
|
||||||
stomp_password: password for connecting to the stomp server; defaults
|
stomp_password: password for connecting to the stomp server; defaults
|
||||||
to null.
|
to null.
|
||||||
|
|
||||||
stomp_persistent: keep items across queue server restart, if enabled.
|
stomp_persistent: keep items across queue server restart, if enabled.
|
||||||
|
|
||||||
softlimit: an absolute or relative "soft memory limit"; daemons will
|
softlimit: an absolute or relative "soft memory limit"; daemons will
|
||||||
restart themselves gracefully when they find they've hit
|
restart themselves gracefully when they find they've hit
|
||||||
this amount of memory usage. Defaults to 90% of PHP's global
|
this amount of memory usage. Defaults to 90% of PHP's global
|
||||||
memory_limit setting.
|
memory_limit setting.
|
||||||
|
|
||||||
inboxes: delivery of messages to receiver's inboxes can be delayed to
|
inboxes: delivery of messages to receiver's inboxes can be delayed to
|
||||||
queue time for best interactive performance on the sender.
|
queue time for best interactive performance on the sender.
|
||||||
This may however be annoyingly slow when using the DB queues,
|
This may however be annoyingly slow when using the DB queues,
|
||||||
so you can set this to false if it's causing trouble.
|
so you can set this to false if it's causing trouble.
|
||||||
|
|
||||||
breakout: for stomp, individual queues are by default grouped up for
|
breakout: for stomp, individual queues are by default grouped up for
|
||||||
best scalability. If some need to be run by separate daemons,
|
best scalability. If some need to be run by separate daemons,
|
||||||
etc they can be manually adjusted here.
|
etc they can be manually adjusted here.
|
||||||
|
|
||||||
Default will share all queues for all sites within each group.
|
Default will share all queues for all sites within each group.
|
||||||
Specify as <group>/<queue> or <group>/<queue>/<site>,
|
Specify as <group>/<queue> or <group>/<queue>/<site>,
|
||||||
using nickname identifier as site.
|
using nickname identifier as site.
|
||||||
|
|
||||||
'main/distrib' separate "distrib" queue covering all sites
|
'main/distrib' separate "distrib" queue covering all sites
|
||||||
'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
|
'xmpp/xmppout/mysite' separate "xmppout" queue covering just 'mysite'
|
||||||
|
|
||||||
max_retries: for stomp, drop messages after N failed attempts to process.
|
max_retries: for stomp, drop messages after N failed attempts to process.
|
||||||
Defaults to 10.
|
Defaults to 10.
|
||||||
|
|
||||||
dead_letter_dir: for stomp, optional directory to dump data on failed
|
dead_letter_dir: for stomp, optional directory to dump data on failed
|
||||||
queue processing events after discarding them.
|
queue processing events after discarding them.
|
||||||
|
|
||||||
license
|
license
|
||||||
-------
|
-------
|
||||||
|
|
@ -997,11 +997,11 @@ choice for any public site. Note that some other servers will not
|
||||||
accept notices if you apply a stricter license than this.
|
accept notices if you apply a stricter license than this.
|
||||||
|
|
||||||
type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
|
type: one of 'cc' (for Creative Commons licenses), 'allrightsreserved'
|
||||||
(default copyright), or 'private' (for private and confidential
|
(default copyright), or 'private' (for private and confidential
|
||||||
information).
|
information).
|
||||||
owner: for 'allrightsreserved' or 'private', an assigned copyright
|
owner: for 'allrightsreserved' or 'private', an assigned copyright
|
||||||
holder (for example, an employer for a private site). If
|
holder (for example, an employer for a private site). If
|
||||||
not specified, will be attributed to 'contributors'.
|
not specified, will be attributed to 'contributors'.
|
||||||
url: URL of the license, used for links.
|
url: URL of the license, used for links.
|
||||||
title: Title for the license, like 'Creative Commons Attribution 3.0'.
|
title: Title for the license, like 'Creative Commons Attribution 3.0'.
|
||||||
image: A button shown on each page for the license.
|
image: A button shown on each page for the license.
|
||||||
|
|
@ -1013,7 +1013,7 @@ This is for configuring out-going email. We use PEAR's Mail module,
|
||||||
see: http://pear.php.net/manual/en/package.mail.mail.factory.php
|
see: http://pear.php.net/manual/en/package.mail.mail.factory.php
|
||||||
|
|
||||||
backend: the backend to use for mail, one of 'mail', 'sendmail', and
|
backend: the backend to use for mail, one of 'mail', 'sendmail', and
|
||||||
'smtp'. Defaults to PEAR's default, 'mail'.
|
'smtp'. Defaults to PEAR's default, 'mail'.
|
||||||
params: if the mail backend requires any parameters, you can provide
|
params: if the mail backend requires any parameters, you can provide
|
||||||
them in an associative array.
|
them in an associative array.
|
||||||
|
|
||||||
|
|
@ -1023,24 +1023,24 @@ nickname
|
||||||
This is for configuring nicknames in the service.
|
This is for configuring nicknames in the service.
|
||||||
|
|
||||||
blacklist: an array of strings for usernames that may not be
|
blacklist: an array of strings for usernames that may not be
|
||||||
registered. A default array exists for strings that are
|
registered. A default array exists for strings that are
|
||||||
used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
|
used by StatusNet (e.g. 'doc', 'main', 'avatar', 'theme')
|
||||||
but you may want to add others if you have other software
|
but you may want to add others if you have other software
|
||||||
installed in a subdirectory of StatusNet or if you just
|
installed in a subdirectory of StatusNet or if you just
|
||||||
don't want certain words used as usernames.
|
don't want certain words used as usernames.
|
||||||
featured: an array of nicknames of 'featured' users of the site.
|
featured: an array of nicknames of 'featured' users of the site.
|
||||||
Can be useful to draw attention to well-known users, or
|
Can be useful to draw attention to well-known users, or
|
||||||
interesting people, or whatever.
|
interesting people, or whatever.
|
||||||
|
|
||||||
avatar
|
avatar
|
||||||
------
|
------
|
||||||
|
|
||||||
For configuring avatar access.
|
For configuring avatar access.
|
||||||
|
|
||||||
dir: Directory to look for avatar files and to put them into.
|
dir: Directory to look for avatar files and to put them into.
|
||||||
Defaults to avatar subdirectory of install directory; if
|
Defaults to avatar subdirectory of install directory; if
|
||||||
you change it, make sure to change path, too.
|
you change it, make sure to change path, too.
|
||||||
path: Path to avatars. Defaults to path for avatar subdirectory,
|
path: Path to avatars. Defaults to path for avatar subdirectory,
|
||||||
but you can change it if you wish. Note that this will
|
but you can change it if you wish. Note that this will
|
||||||
be included with the avatar server, too.
|
be included with the avatar server, too.
|
||||||
server: If set, defines another server where avatars are stored in the
|
server: If set, defines another server where avatars are stored in the
|
||||||
|
|
@ -1051,8 +1051,8 @@ server: If set, defines another server where avatars are stored in the
|
||||||
typically only make 2 connections to a single server at a
|
typically only make 2 connections to a single server at a
|
||||||
time <http://ur1.ca/6ih>, so this can parallelize the job.
|
time <http://ur1.ca/6ih>, so this can parallelize the job.
|
||||||
Defaults to null.
|
Defaults to null.
|
||||||
ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
|
ssl: Whether to access avatars using HTTPS. Defaults to null, meaning
|
||||||
to guess based on site-wide SSL settings.
|
to guess based on site-wide SSL settings.
|
||||||
|
|
||||||
public
|
public
|
||||||
------
|
------
|
||||||
|
|
@ -1060,13 +1060,13 @@ public
|
||||||
For configuring the public stream.
|
For configuring the public stream.
|
||||||
|
|
||||||
localonly: If set to true, only messages posted by users of this
|
localonly: If set to true, only messages posted by users of this
|
||||||
service (rather than other services, filtered through OMB)
|
service (rather than other services, filtered through OMB)
|
||||||
are shown in the public stream. Default true.
|
are shown in the public stream. Default true.
|
||||||
blacklist: An array of IDs of users to hide from the public stream.
|
blacklist: An array of IDs of users to hide from the public stream.
|
||||||
Useful if you have someone making excessive Twitterfeed posts
|
Useful if you have someone making excessive Twitterfeed posts
|
||||||
to the site, other kinds of automated posts, testing bots, etc.
|
to the site, other kinds of automated posts, testing bots, etc.
|
||||||
autosource: Sources of notices that are from automatic posters, and thus
|
autosource: Sources of notices that are from automatic posters, and thus
|
||||||
should be kept off the public timeline. Default empty.
|
should be kept off the public timeline. Default empty.
|
||||||
|
|
||||||
theme
|
theme
|
||||||
-----
|
-----
|
||||||
|
|
@ -1074,15 +1074,15 @@ theme
|
||||||
server: Like avatars, you can speed up page loading by pointing the
|
server: Like avatars, you can speed up page loading by pointing the
|
||||||
theme file lookup to another server (virtual or real).
|
theme file lookup to another server (virtual or real).
|
||||||
Defaults to NULL, meaning to use the site server.
|
Defaults to NULL, meaning to use the site server.
|
||||||
dir: Directory where theme files are stored. Used to determine
|
dir: Directory where theme files are stored. Used to determine
|
||||||
whether to show parts of a theme file. Defaults to the theme
|
whether to show parts of a theme file. Defaults to the theme
|
||||||
subdirectory of the install directory.
|
subdirectory of the install directory.
|
||||||
path: Path part of theme URLs, before the theme name. Relative to the
|
path: Path part of theme URLs, before the theme name. Relative to the
|
||||||
theme server. It may make sense to change this path when upgrading,
|
theme server. It may make sense to change this path when upgrading,
|
||||||
(using version numbers as the path) to make sure that all files are
|
(using version numbers as the path) to make sure that all files are
|
||||||
reloaded by caching clients or proxies. Defaults to null,
|
reloaded by caching clients or proxies. Defaults to null,
|
||||||
which means to use the site path + '/theme'.
|
which means to use the site path + '/theme'.
|
||||||
ssl: Whether to use SSL for theme elements. Default is null, which means
|
ssl: Whether to use SSL for theme elements. Default is null, which means
|
||||||
guess based on site SSL settings.
|
guess based on site SSL settings.
|
||||||
|
|
||||||
javascript
|
javascript
|
||||||
|
|
@ -1091,9 +1091,9 @@ javascript
|
||||||
server: You can speed up page loading by pointing the
|
server: You can speed up page loading by pointing the
|
||||||
theme file lookup to another server (virtual or real).
|
theme file lookup to another server (virtual or real).
|
||||||
Defaults to NULL, meaning to use the site server.
|
Defaults to NULL, meaning to use the site server.
|
||||||
path: Path part of Javascript URLs. Defaults to null,
|
path: Path part of Javascript URLs. Defaults to null,
|
||||||
which means to use the site path + '/js/'.
|
which means to use the site path + '/js/'.
|
||||||
ssl: Whether to use SSL for JavaScript files. Default is null, which means
|
ssl: Whether to use SSL for JavaScript files. Default is null, which means
|
||||||
guess based on site SSL settings.
|
guess based on site SSL settings.
|
||||||
|
|
||||||
xmpp
|
xmpp
|
||||||
|
|
@ -1104,25 +1104,25 @@ For configuring the XMPP sub-system.
|
||||||
enabled: Whether to accept and send messages by XMPP. Default false.
|
enabled: Whether to accept and send messages by XMPP. Default false.
|
||||||
server: server part of XMPP ID for update user.
|
server: server part of XMPP ID for update user.
|
||||||
port: connection port for clients. Default 5222, which you probably
|
port: connection port for clients. Default 5222, which you probably
|
||||||
shouldn't need to change.
|
shouldn't need to change.
|
||||||
user: username for the client connection. Users will receive messages
|
user: username for the client connection. Users will receive messages
|
||||||
from 'user'@'server'.
|
from 'user'@'server'.
|
||||||
resource: a unique identifier for the connection to the server. This
|
resource: a unique identifier for the connection to the server. This
|
||||||
is actually used as a prefix for each XMPP component in the system.
|
is actually used as a prefix for each XMPP component in the system.
|
||||||
password: password for the user account.
|
password: password for the user account.
|
||||||
host: some XMPP domains are served by machines with a different
|
host: some XMPP domains are served by machines with a different
|
||||||
hostname. (For example, @gmail.com GTalk users connect to
|
hostname. (For example, @gmail.com GTalk users connect to
|
||||||
talk.google.com). Set this to the correct hostname if that's the
|
talk.google.com). Set this to the correct hostname if that's the
|
||||||
case with your server.
|
case with your server.
|
||||||
encryption: Whether to encrypt the connection between StatusNet and the
|
encryption: Whether to encrypt the connection between StatusNet and the
|
||||||
XMPP server. Defaults to true, but you can get
|
XMPP server. Defaults to true, but you can get
|
||||||
considerably better performance turning it off if you're
|
considerably better performance turning it off if you're
|
||||||
connecting to a server on the same machine or on a
|
connecting to a server on the same machine or on a
|
||||||
protected network.
|
protected network.
|
||||||
debug: if turned on, this will make the XMPP library blurt out all of
|
debug: if turned on, this will make the XMPP library blurt out all of
|
||||||
the incoming and outgoing messages as XML stanzas. Use as a
|
the incoming and outgoing messages as XML stanzas. Use as a
|
||||||
last resort, and never turn it on if you don't have queues
|
last resort, and never turn it on if you don't have queues
|
||||||
enabled, since it will spit out sensitive data to the browser.
|
enabled, since it will spit out sensitive data to the browser.
|
||||||
public: an array of JIDs to send _all_ notices to. This is useful for
|
public: an array of JIDs to send _all_ notices to. This is useful for
|
||||||
participating in third-party search and archiving services.
|
participating in third-party search and archiving services.
|
||||||
|
|
||||||
|
|
@ -1139,8 +1139,8 @@ tag
|
||||||
Miscellaneous tagging stuff.
|
Miscellaneous tagging stuff.
|
||||||
|
|
||||||
dropoff: Decay factor for tag listing, in seconds.
|
dropoff: Decay factor for tag listing, in seconds.
|
||||||
Defaults to exponential decay over ten days; you can twiddle
|
Defaults to exponential decay over ten days; you can twiddle
|
||||||
with it to try and get better results for your site.
|
with it to try and get better results for your site.
|
||||||
|
|
||||||
popular
|
popular
|
||||||
-------
|
-------
|
||||||
|
|
@ -1148,8 +1148,8 @@ popular
|
||||||
Settings for the "popular" section of the site.
|
Settings for the "popular" section of the site.
|
||||||
|
|
||||||
dropoff: Decay factor for popularity listing, in seconds.
|
dropoff: Decay factor for popularity listing, in seconds.
|
||||||
Defaults to exponential decay over ten days; you can twiddle
|
Defaults to exponential decay over ten days; you can twiddle
|
||||||
with it to try and get better results for your site.
|
with it to try and get better results for your site.
|
||||||
|
|
||||||
daemon
|
daemon
|
||||||
------
|
------
|
||||||
|
|
@ -1160,11 +1160,11 @@ piddir: directory that daemon processes should write their PID file
|
||||||
(process ID) to. Defaults to /var/run/, which is where this
|
(process ID) to. Defaults to /var/run/, which is where this
|
||||||
stuff should usually go on Unix-ish systems.
|
stuff should usually go on Unix-ish systems.
|
||||||
user: If set, the daemons will try to change their effective user ID
|
user: If set, the daemons will try to change their effective user ID
|
||||||
to this user before running. Probably a good idea, especially if
|
to this user before running. Probably a good idea, especially if
|
||||||
you start the daemons as root. Note: user name, like 'daemon',
|
you start the daemons as root. Note: user name, like 'daemon',
|
||||||
not 1001.
|
not 1001.
|
||||||
group: If set, the daemons will try to change their effective group ID
|
group: If set, the daemons will try to change their effective group ID
|
||||||
to this named group. Again, a name, not a numerical ID.
|
to this named group. Again, a name, not a numerical ID.
|
||||||
|
|
||||||
memcached
|
memcached
|
||||||
---------
|
---------
|
||||||
|
|
@ -1176,11 +1176,11 @@ enabled: Set to true to enable. Default false.
|
||||||
server: a string with the hostname of the memcached server. Can also
|
server: a string with the hostname of the memcached server. Can also
|
||||||
be an array of hostnames, if you've got more than one server.
|
be an array of hostnames, if you've got more than one server.
|
||||||
base: memcached uses key-value pairs to store data. We build long,
|
base: memcached uses key-value pairs to store data. We build long,
|
||||||
funny-looking keys to make sure we don't have any conflicts. The
|
funny-looking keys to make sure we don't have any conflicts. The
|
||||||
base of the key is usually a simplified version of the site name
|
base of the key is usually a simplified version of the site name
|
||||||
(like "Identi.ca" => "identica"), but you can overwrite this if
|
(like "Identi.ca" => "identica"), but you can overwrite this if
|
||||||
you need to. You can safely ignore it if you only have one
|
you need to. You can safely ignore it if you only have one
|
||||||
StatusNet site using your memcached server.
|
StatusNet site using your memcached server.
|
||||||
port: Port to connect to; defaults to 11211.
|
port: Port to connect to; defaults to 11211.
|
||||||
|
|
||||||
emailpost
|
emailpost
|
||||||
|
|
@ -1189,7 +1189,7 @@ emailpost
|
||||||
For post-by-email.
|
For post-by-email.
|
||||||
|
|
||||||
enabled: Whether to enable post-by-email. Defaults to true. You will
|
enabled: Whether to enable post-by-email. Defaults to true. You will
|
||||||
also need to set up maildaemon.php.
|
also need to set up maildaemon.php.
|
||||||
|
|
||||||
sms
|
sms
|
||||||
---
|
---
|
||||||
|
|
@ -1197,7 +1197,7 @@ sms
|
||||||
For SMS integration.
|
For SMS integration.
|
||||||
|
|
||||||
enabled: Whether to enable SMS integration. Defaults to true. Queues
|
enabled: Whether to enable SMS integration. Defaults to true. Queues
|
||||||
should also be enabled.
|
should also be enabled.
|
||||||
|
|
||||||
integration
|
integration
|
||||||
-----------
|
-----------
|
||||||
|
|
@ -1212,7 +1212,7 @@ inboxes
|
||||||
For notice inboxes.
|
For notice inboxes.
|
||||||
|
|
||||||
enabled: No longer used. If you set this to something other than true,
|
enabled: No longer used. If you set this to something other than true,
|
||||||
StatusNet will no longer run.
|
StatusNet will no longer run.
|
||||||
|
|
||||||
throttle
|
throttle
|
||||||
--------
|
--------
|
||||||
|
|
@ -1221,8 +1221,8 @@ For notice-posting throttles.
|
||||||
|
|
||||||
enabled: Whether to throttle posting. Defaults to false.
|
enabled: Whether to throttle posting. Defaults to false.
|
||||||
count: Each user can make this many posts in 'timespan' seconds. So, if count
|
count: Each user can make this many posts in 'timespan' seconds. So, if count
|
||||||
is 100 and timespan is 3600, then there can be only 100 posts
|
is 100 and timespan is 3600, then there can be only 100 posts
|
||||||
from a user every hour.
|
from a user every hour.
|
||||||
timespan: see 'count'.
|
timespan: see 'count'.
|
||||||
|
|
||||||
profile
|
profile
|
||||||
|
|
@ -1231,7 +1231,7 @@ profile
|
||||||
Profile management.
|
Profile management.
|
||||||
|
|
||||||
biolimit: max character length of bio; 0 means no limit; null means to use
|
biolimit: max character length of bio; 0 means no limit; null means to use
|
||||||
the site text limit default.
|
the site text limit default.
|
||||||
|
|
||||||
newuser
|
newuser
|
||||||
-------
|
-------
|
||||||
|
|
@ -1239,13 +1239,13 @@ newuser
|
||||||
Options with new users.
|
Options with new users.
|
||||||
|
|
||||||
default: nickname of a user account to automatically subscribe new
|
default: nickname of a user account to automatically subscribe new
|
||||||
users to. Typically this would be system account for e.g.
|
users to. Typically this would be system account for e.g.
|
||||||
service updates or announcements. Users are able to unsub
|
service updates or announcements. Users are able to unsub
|
||||||
if they want. Default is null; no auto subscribe.
|
if they want. Default is null; no auto subscribe.
|
||||||
welcome: nickname of a user account that sends welcome messages to new
|
welcome: nickname of a user account that sends welcome messages to new
|
||||||
users. Can be the same as 'default' account, although on
|
users. Can be the same as 'default' account, although on
|
||||||
busy servers it may be a good idea to keep that one just for
|
busy servers it may be a good idea to keep that one just for
|
||||||
'urgent' messages. Default is null; no message.
|
'urgent' messages. Default is null; no message.
|
||||||
|
|
||||||
If either of these special user accounts are specified, the users should
|
If either of these special user accounts are specified, the users should
|
||||||
be created before the configuration is updated.
|
be created before the configuration is updated.
|
||||||
|
|
@ -1262,19 +1262,19 @@ helps StatusNet developers take your needs into account when updating
|
||||||
the software.
|
the software.
|
||||||
|
|
||||||
run: string indicating when to run the statistics. Values can be 'web'
|
run: string indicating when to run the statistics. Values can be 'web'
|
||||||
(run occasionally at Web time), 'cron' (run from a cron script),
|
(run occasionally at Web time), 'cron' (run from a cron script),
|
||||||
or 'never' (don't ever run). If you set it to 'cron', remember to
|
or 'never' (don't ever run). If you set it to 'cron', remember to
|
||||||
schedule the script to run on a regular basis.
|
schedule the script to run on a regular basis.
|
||||||
frequency: if run value is 'web', how often to report statistics.
|
frequency: if run value is 'web', how often to report statistics.
|
||||||
Measured in Web hits; depends on how active your site is.
|
Measured in Web hits; depends on how active your site is.
|
||||||
Default is 10000 -- that is, one report every 10000 Web hits,
|
Default is 10000 -- that is, one report every 10000 Web hits,
|
||||||
on average.
|
on average.
|
||||||
reporturl: URL to post statistics to. Defaults to StatusNet developers'
|
reporturl: URL to post statistics to. Defaults to StatusNet developers'
|
||||||
report system, but if they go evil or disappear you may
|
report system, but if they go evil or disappear you may
|
||||||
need to update this to another value. Note: if you
|
need to update this to another value. Note: if you
|
||||||
don't want to report stats, it's much better to
|
don't want to report stats, it's much better to
|
||||||
set 'run' to 'never' than to set this value to something
|
set 'run' to 'never' than to set this value to something
|
||||||
nonsensical.
|
nonsensical.
|
||||||
|
|
||||||
attachments
|
attachments
|
||||||
-----------
|
-----------
|
||||||
|
|
@ -1287,14 +1287,14 @@ We suggest the use of the pecl file_info extension to handle mime type
|
||||||
detection.
|
detection.
|
||||||
|
|
||||||
supported: an array of mime types you accept to store and distribute,
|
supported: an array of mime types you accept to store and distribute,
|
||||||
like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
|
like 'image/gif', 'video/mpeg', 'audio/mpeg', etc. Make sure you
|
||||||
setup your server to properly recognize the types you want to
|
setup your server to properly recognize the types you want to
|
||||||
support.
|
support.
|
||||||
uploads: false to disable uploading files with notices (true by default).
|
uploads: false to disable uploading files with notices (true by default).
|
||||||
filecommand: The required MIME_Type library may need to use the 'file'
|
filecommand: The required MIME_Type library may need to use the 'file'
|
||||||
command. It tries the one in the Web server's path, but if
|
command. It tries the one in the Web server's path, but if
|
||||||
you're having problems with uploads, try setting this to the
|
you're having problems with uploads, try setting this to the
|
||||||
correct value. Note: 'file' must accept '-b' and '-i' options.
|
correct value. Note: 'file' must accept '-b' and '-i' options.
|
||||||
|
|
||||||
For quotas, be sure you've set the upload_max_filesize and post_max_size
|
For quotas, be sure you've set the upload_max_filesize and post_max_size
|
||||||
in php.ini to be large enough to handle your upload. In httpd.conf
|
in php.ini to be large enough to handle your upload. In httpd.conf
|
||||||
|
|
@ -1302,26 +1302,26 @@ in php.ini to be large enough to handle your upload. In httpd.conf
|
||||||
set too low (it's optional, so it may not be there at all).
|
set too low (it's optional, so it may not be there at all).
|
||||||
|
|
||||||
file_quota: maximum size for a single file upload in bytes. A user can send
|
file_quota: maximum size for a single file upload in bytes. A user can send
|
||||||
any amount of notices with attachments as long as each attachment
|
any amount of notices with attachments as long as each attachment
|
||||||
is smaller than file_quota.
|
is smaller than file_quota.
|
||||||
user_quota: total size in bytes a user can store on this server. Each user
|
user_quota: total size in bytes a user can store on this server. Each user
|
||||||
can store any number of files as long as their total size does
|
can store any number of files as long as their total size does
|
||||||
not exceed the user_quota.
|
not exceed the user_quota.
|
||||||
monthly_quota: total size permitted in the current month. This is the total
|
monthly_quota: total size permitted in the current month. This is the total
|
||||||
size in bytes that a user can upload each month.
|
size in bytes that a user can upload each month.
|
||||||
dir: directory accessible to the Web process where uploads should go.
|
dir: directory accessible to the Web process where uploads should go.
|
||||||
Defaults to the 'file' subdirectory of the install directory, which
|
Defaults to the 'file' subdirectory of the install directory, which
|
||||||
should be writeable by the Web user.
|
should be writeable by the Web user.
|
||||||
server: server name to use when creating URLs for uploaded files.
|
server: server name to use when creating URLs for uploaded files.
|
||||||
Defaults to null, meaning to use the default Web server. Using
|
Defaults to null, meaning to use the default Web server. Using
|
||||||
a virtual server here can speed up Web performance.
|
a virtual server here can speed up Web performance.
|
||||||
path: URL path, relative to the server, to find files. Defaults to
|
path: URL path, relative to the server, to find files. Defaults to
|
||||||
main path + '/file/'.
|
main path + '/file/'.
|
||||||
ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
|
ssl: whether to use HTTPS for file URLs. Defaults to null, meaning to
|
||||||
guess based on other SSL settings.
|
guess based on other SSL settings.
|
||||||
filecommand: command to use for determining the type of a file. May be
|
filecommand: command to use for determining the type of a file. May be
|
||||||
skipped if fileinfo extension is installed. Defaults to
|
skipped if fileinfo extension is installed. Defaults to
|
||||||
'/usr/bin/file'.
|
'/usr/bin/file'.
|
||||||
|
|
||||||
group
|
group
|
||||||
-----
|
-----
|
||||||
|
|
@ -1329,10 +1329,10 @@ group
|
||||||
Options for group functionality.
|
Options for group functionality.
|
||||||
|
|
||||||
maxaliases: maximum number of aliases a group can have. Default 3. Set
|
maxaliases: maximum number of aliases a group can have. Default 3. Set
|
||||||
to 0 or less to prevent aliases in a group.
|
to 0 or less to prevent aliases in a group.
|
||||||
desclimit: maximum number of characters to allow in group descriptions.
|
desclimit: maximum number of characters to allow in group descriptions.
|
||||||
null (default) means to use the site-wide text limits. 0
|
null (default) means to use the site-wide text limits. 0
|
||||||
means no limit.
|
means no limit.
|
||||||
|
|
||||||
oohembed
|
oohembed
|
||||||
--------
|
--------
|
||||||
|
|
@ -1347,11 +1347,11 @@ search
|
||||||
Some stuff for search.
|
Some stuff for search.
|
||||||
|
|
||||||
type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
|
type: type of search. Ignored if PostgreSQL or Sphinx are enabled. Can either
|
||||||
be 'fulltext' (default) or 'like'. The former is faster and more efficient
|
be 'fulltext' (default) or 'like'. The former is faster and more efficient
|
||||||
but requires the lame old MyISAM engine for MySQL. The latter
|
but requires the lame old MyISAM engine for MySQL. The latter
|
||||||
will work with InnoDB but could be miserably slow on large
|
will work with InnoDB but could be miserably slow on large
|
||||||
systems. We'll probably add another type sometime in the future,
|
systems. We'll probably add another type sometime in the future,
|
||||||
with our own indexing system (maybe like MediaWiki's).
|
with our own indexing system (maybe like MediaWiki's).
|
||||||
|
|
||||||
sessions
|
sessions
|
||||||
--------
|
--------
|
||||||
|
|
@ -1363,7 +1363,7 @@ handle: boolean. Whether we should register our own PHP session-handling
|
||||||
Setting this to true makes some sense on large or multi-server
|
Setting this to true makes some sense on large or multi-server
|
||||||
sites, but it probably won't hurt for smaller ones, either.
|
sites, but it probably won't hurt for smaller ones, either.
|
||||||
debug: whether to output debugging info for session storage. Can help
|
debug: whether to output debugging info for session storage. Can help
|
||||||
with weird session bugs, sometimes. Default false.
|
with weird session bugs, sometimes. Default false.
|
||||||
|
|
||||||
background
|
background
|
||||||
----------
|
----------
|
||||||
|
|
@ -1372,14 +1372,14 @@ Users can upload backgrounds for their pages; this section defines
|
||||||
their use.
|
their use.
|
||||||
|
|
||||||
server: the server to use for background. Using a separate (even
|
server: the server to use for background. Using a separate (even
|
||||||
virtual) server for this can speed up load times. Default is
|
virtual) server for this can speed up load times. Default is
|
||||||
null; same as site server.
|
null; same as site server.
|
||||||
dir: directory to write backgrounds too. Default is '/background/'
|
dir: directory to write backgrounds too. Default is '/background/'
|
||||||
subdir of install dir.
|
subdir of install dir.
|
||||||
path: path to backgrounds. Default is sub-path of install path; note
|
path: path to backgrounds. Default is sub-path of install path; note
|
||||||
that you may need to change this if you change site-path too.
|
that you may need to change this if you change site-path too.
|
||||||
ssl: Whether or not to use HTTPS for background files. Defaults to
|
ssl: Whether or not to use HTTPS for background files. Defaults to
|
||||||
null, meaning to guess from site-wide SSL settings.
|
null, meaning to guess from site-wide SSL settings.
|
||||||
|
|
||||||
ping
|
ping
|
||||||
----
|
----
|
||||||
|
|
@ -1388,7 +1388,7 @@ Using the "XML-RPC Ping" method initiated by weblogs.com, the site can
|
||||||
notify third-party servers of updates.
|
notify third-party servers of updates.
|
||||||
|
|
||||||
notify: an array of URLs for ping endpoints. Default is the empty
|
notify: an array of URLs for ping endpoints. Default is the empty
|
||||||
array (no notification).
|
array (no notification).
|
||||||
|
|
||||||
design
|
design
|
||||||
------
|
------
|
||||||
|
|
@ -1410,8 +1410,8 @@ notice
|
||||||
Configuration options specific to notices.
|
Configuration options specific to notices.
|
||||||
|
|
||||||
contentlimit: max length of the plain-text content of a notice.
|
contentlimit: max length of the plain-text content of a notice.
|
||||||
Default is null, meaning to use the site-wide text limit.
|
Default is null, meaning to use the site-wide text limit.
|
||||||
0 means no limit.
|
0 means no limit.
|
||||||
|
|
||||||
message
|
message
|
||||||
-------
|
-------
|
||||||
|
|
@ -1419,8 +1419,8 @@ message
|
||||||
Configuration options specific to messages.
|
Configuration options specific to messages.
|
||||||
|
|
||||||
contentlimit: max length of the plain-text content of a message.
|
contentlimit: max length of the plain-text content of a message.
|
||||||
Default is null, meaning to use the site-wide text limit.
|
Default is null, meaning to use the site-wide text limit.
|
||||||
0 means no limit.
|
0 means no limit.
|
||||||
|
|
||||||
logincommand
|
logincommand
|
||||||
------------
|
------------
|
||||||
|
|
@ -1428,14 +1428,14 @@ logincommand
|
||||||
Configuration options for the login command.
|
Configuration options for the login command.
|
||||||
|
|
||||||
disabled: whether to enable this command. If enabled, users who send
|
disabled: whether to enable this command. If enabled, users who send
|
||||||
the text 'login' to the site through any channel will
|
the text 'login' to the site through any channel will
|
||||||
receive a link to login to the site automatically in return.
|
receive a link to login to the site automatically in return.
|
||||||
Possibly useful for users who primarily use an XMPP or SMS
|
Possibly useful for users who primarily use an XMPP or SMS
|
||||||
interface and can't be bothered to remember their site
|
interface and can't be bothered to remember their site
|
||||||
password. Note that the security implications of this are
|
password. Note that the security implications of this are
|
||||||
pretty serious and have not been thoroughly tested. You
|
pretty serious and have not been thoroughly tested. You
|
||||||
should enable it only after you've convinced yourself that
|
should enable it only after you've convinced yourself that
|
||||||
it is safe. Default is 'false'.
|
it is safe. Default is 'false'.
|
||||||
|
|
||||||
singleuser
|
singleuser
|
||||||
----------
|
----------
|
||||||
|
|
@ -1454,11 +1454,11 @@ Web crawlers. See http://www.robotstxt.org/ for more information
|
||||||
on the format of this file.
|
on the format of this file.
|
||||||
|
|
||||||
crawldelay: if non-empty, this value is provided as the Crawl-Delay:
|
crawldelay: if non-empty, this value is provided as the Crawl-Delay:
|
||||||
for the robots.txt file. see http://ur1.ca/l5a0
|
for the robots.txt file. see http://ur1.ca/l5a0
|
||||||
for more information. Default is zero, no explicit delay.
|
for more information. Default is zero, no explicit delay.
|
||||||
disallow: Array of (virtual) directories to disallow. Default is 'main',
|
disallow: Array of (virtual) directories to disallow. Default is 'main',
|
||||||
'search', 'message', 'settings', 'admin'. Ignored when site
|
'search', 'message', 'settings', 'admin'. Ignored when site
|
||||||
is private, in which case the entire site ('/') is disallowed.
|
is private, in which case the entire site ('/') is disallowed.
|
||||||
|
|
||||||
Plugins
|
Plugins
|
||||||
=======
|
=======
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user