This commit is contained in:
2019-02-06 00:49:12 +03:00
commit 8dbb1bb605
4796 changed files with 506072 additions and 0 deletions

View File

@@ -0,0 +1,52 @@
<chapter id="lj.admin.caps">
<chapterinfo>
<title>Capabilities Classes</title>
</chapterinfo>
<title>Capabilities Classes</title>
<section id="lj.admin.caps.intro">
<title>Introduction</title>
<para>
To introduce user limitations as defined on a per site basis, LiveJournal has implemented
the use of <quote>capabilities</quote> &mdash; customizable limits that can be defined &eacute;n mass&eacute;, or
split between different user <quote>types</quote>.
</para>
<para>
Completing the idea of <quote>per site definitions</quote>, we've implemented a system where
capabilities can be defined in classes, and classes can either be turned <quote>on</quote> or
<quote>off</quote> for each account.
</para>
<para>
Capability classes are most effectively used when making distinctions between <quote>normal</quote>
user accounts and <quote>privileged</quote> user accounts; for example, on LiveJournal.com, we make
a distinction between <quote>normal</quote> accounts, <quote>early adopter</quote> accounts, and
<quote>paid</quote> accounts, (with a couple of variations on the latter) &mdash; the purpose of the
distinction being to give paying members a better incentive to stick around and help fund the site.
</para>
</section>
<section id="lj.admin.caps.usage">
<title>Setting Capabilities</title>
<para>
<xref linkend="lj.install.ljconfig.caps" /> explains how to initially set the capability defaults, and
how to setup capability classes that you can use to define different account types.
</para>
<para>
If there comes a need where a user's account should change classes, then it is easy to administrate from
the <abbrev>URI</abbrev> <filename>/admin/capedit.bml</filename>. Simply login as the system account,
and apply (or unapply) the different classes as necessary for a specific user.
</para>
<formalpara><title>Setting the same capability twice</title><para>
If two capability classes set the same capability, and an account is defined under both classes, then
the conflicting capability values are compared against each other, and the optimal setting is used
where appropriate.
</para></formalpara>
</section>
<section id="lj.admin.caps.list">
<title>Capabilities Reference</title>
<para>
The following is a list of capabilities that you can define per class.
If you have any capabilities that you have defined locally, then they will
be listed here as well.
</para>
&lj.admin.cap_list;
</section>
</chapter>

View File

@@ -0,0 +1,50 @@
<chapter id="lj.admin.console" status="draft">
<title>The Administrative Console</title>
<para>
If you would consider <abbrev>BML</abbrev> pages to be the <abbrev>GUI</abbrev>
of LiveJournal, then the administrative console would be the command line interface.
</para>
<section id="lj.admin.console.intro">
<title>Taking control of the Console</title>
<para>
The administrative console (or <quote>console</quote>, for the sake of brevity) is
a text only interface to LiveJournal that allows you to perform certain administrative
tasks not accessibly anywhere else in your installation. The console, located at the
<abbrev>URI</abbrev> <filename>/admin/console/</filename> of a working LiveJournal
installation, works very similarly to a <acronym>DOS</acronym> or <acronym>bash</acronym>
prompt, in that it reads commands and arguments seperated by whitespace.
</para>
<formalpara><title>Inputting Comands</title><para>
The first word inputted is the command you would like to perform. Every word after that
is an argument to that command, and whitespace delimits multiple arguments. If an argument
requires a space, such as writing suspension notes, it needs to be wrapped in quotation marks.
If an argument requires spaces <emphasis>and</emphasis> quotation marks, then the quotation marks
can be <quote>escaped</quote> with a leading backslash, like: <userinput>\"</userinput>. If
an explicit backslash is required when writing an argument in quotation marks, it can be escaped
with a leading backslash, like <userinput>\\</userinput>.
<example>
<title>Using the console to suspend a user</title>
<para>
To cover all points, here is a typical input line that suspends
<quote>username</quote> with a complex suspension note:
</para>
<userinput>suspend username "Indefinite suspension \\ might become \"permanent\" \\ harassment and libel"</userinput>
</example>
</para></formalpara>
</section>
<section id="lj.admin.console.ref">
<title>Console Command Reference</title>
<para>
Arguments are defined on a per command basis, and some arguments are required for the command to work.
If you&apos;re ever stuck, you can simply type <userinput>help <replaceable>command</replaceable></userinput>
in the console for a short explanation of <replaceable>command</replaceable>.
</para>
<note>
<para>
Included with the installation is a live reference located at the <abbrev>URI</abbrev>
<filename>/admin/console/reference.bml</filename>
</para>
</note>
&lj.admin.console.ref;
</section>
</chapter>

View File

@@ -0,0 +1,20 @@
<chapter id="lj.admin.creatingusers">
<chapterinfo>
<title>Creating Users</title>
</chapterinfo>
<title>Creating Users</title>
<para>
Once you have your LiveJournal server tuned and tweaked, you're probably going to want to create some users and communitiies.
</para>
<para>
Creating users is relatively simple, and depends on which options you are using in your <filename>cgi-bin/ljconfig.pl</filename>.
<note>
<para>
If you are not using this file for your setup, then the default options defined in <filename>cgi-bin/ljdefaults.pl</filename> will be assumed.
</para>
</note>
</para>
<para>
If your service is live, simple visit <filename>create.bml</filename> in your <filename>htdocs/</filename> directory. With this page, you can create as many users as you'd like.
</para>
</chapter>

View File

@@ -0,0 +1,20 @@
<chapter id="lj.admin.creatingusers">
<chapterinfo>
<title>Creating Users</title>
</chapterinfo>
<title>Creating Users</title>
<para>
Once you have your LiveJournal server tuned and tweaked, you're probably going to want to create some users and communitiies.
</para>
<para>
Creating users is relatively simple, and depends on which options you are using in your <filename>cgi-bin/ljconfig.pl</filename>.
<note>
<para>
If you are not using this file for your setup, then the default options defined in <filename>cgi-bin/ljdefaults.pl</filename> will be assumed.
</para>
</note>
</para>
<para>
If your service is live, simple visit <filename>create.bml</filename> in your <filename>htdocs/<filename> directory. With this page, you can create as many users as you'd like.
</para>
</chapter>

View File

@@ -0,0 +1,17 @@
<part id="lj.admin.index" status="prelim">
<title>Administering a LiveJournal Site</title>
<partintro>
<simpara>Part III covers all of the information necessary to fine-tune and run your LiveJournal site.</simpara>
</partintro>
&lj.admin.createusers;
&lj.admin.caps;
&lj.admin.privs;
&lj.admin.console;
&lj.admin.sysban;
</part>
<!--
Local Variables:
mode:sgml
sgml-parent-document: ("../index.xml" "book" "part")
End:
-->

View File

@@ -0,0 +1,29 @@
<chapter id="lj.admin.privs">
<chapterinfo>
<title>Administrating Privileges</title>
</chapterinfo>
<title>Administrating Privileges</title>
<para>
Privileges on LiveJournal are used to delegate responsibilities to other users,
without having to modify access files or setting explicit file permissions on
<filename>.bml</filename> files.
</para>
<section id="lj.admin.privs.intro">
<title>Using privs effectively</title>
<para>
All privileges can be administered through the privilege portal, located at the
<abbrev>URI</abbrev> <filename>/admin/priv/</filename> in installations of LiveJournal.
To start administrating privs, you should login as the system account you created in
<xref linkend="lj.install.finishing" /><footnote><para>
The script <filename>bin/upgrading/make_system.pl</filename> creates the system account,
and grants it the <literal>admin</literal> priv with the argument of <quote>all</quote>.
</para></footnote>. By visiting the <filename>/admin/priv</filename> portal, you can start
assigning privs either by username or privilege name.
</para>
</section>
<section id="lj.admin.privs.ref">
<title>A list of all Privs</title>
<para>The following is a complete privilege reference.</para>
&lj.admin.privs.ref;
</section>
</chapter>

View File

@@ -0,0 +1,55 @@
<chapter id="lj.admin.sysban">
<title>Banning Users</title>
<para>The LiveJournal <quote>sysban</quote> mechanism provides the means for generic bans on
site functionality given a block type and value. The type is what
is being checked (IP address, email address, etc) and the value is the value which
causes the block to activate. (<literal>10.0.0.10</literal>, for example)</para>
<para>A tool is available to create and modify bans: <filename><envar>$LJHOME</envar>/htdocs/admin/sysban.bml</filename>.
This tool requires the <varname>sysban</varname> privilege.</para>
<variablelist>
<para>There are three <literal>statushistory</literal> types tied to the sysban tool:</para>
<varlistentry>
<term><varname>sysban_add</varname></term>
<listitem><simpara>Logs the creation of new bans</simpara></listitem>
</varlistentry>
<varlistentry>
<term><varname>sysban_mod</varname></term>
<listitem><simpara>Logs the modification of bans</simpara></listitem>
</varlistentry>
<varlistentry>
<term><varname>sysban_trig</varname></term>
<listitem><simpara>Logs when bans are triggered</simpara></listitem>
</varlistentry>
</variablelist>
<para>The most notable of the three is the <varname>sysban_trig</varname> type. The data it
logs varies depending on the type of ban and the information
available when it was triggered. If a userid is available, it
will be logged and the notes column will contain a short description
of what caused the trigger along with a number of variables that
may be useful in investigation of the situation.</para>
<para>Below are the ban types that exist as of now. More can and will be added
as necessary:</para>
<variablelist>
<title>General</title>
<varlistentry>
<term><varname>ip</varname></term>
<listitem><simpara>Blocked from site if IP address matches</simpara></listitem>
</varlistentry>
<varlistentry>
<term><varname>email</varname></term>
<listitem><para>Blocked if email matches.<variablelist>
<varlistentry>
<term><filename>/create.bml</filename></term>
<listitem><simpara>Return a fake <quote>503 Service Unavailable</quote> message to a user
who tries to create a new account with the given email address.</simpara></listitem>
</varlistentry>
</variablelist></para></listitem>
</varlistentry>
</variablelist>
</chapter>
<!--
Local Variables:
mode:sgml
sgml-parent-document: ("index.xml" "part" "chapter")
End:
-->