diff options
Diffstat (limited to 'httemplate/docs')
| -rw-r--r-- | httemplate/docs/AGPL.html | 672 | ||||
| -rw-r--r-- | httemplate/docs/about.html | 53 | ||||
| -rw-r--r-- | httemplate/docs/ach.html | 10 | ||||
| -rwxr-xr-x | httemplate/docs/admin.html | 41 | ||||
| -rw-r--r-- | httemplate/docs/credits.html | 175 | ||||
| -rw-r--r-- | httemplate/docs/cvv2.html | 24 | ||||
| -rw-r--r-- | httemplate/docs/ieak.html | 75 | ||||
| -rw-r--r-- | httemplate/docs/index.html | 32 | ||||
| -rwxr-xr-x | httemplate/docs/legacy.html | 39 | ||||
| -rw-r--r-- | httemplate/docs/license.html | 116 | ||||
| -rw-r--r-- | httemplate/docs/man/FS/part_export/.cvs_is_on_crack | 0 | ||||
| -rw-r--r-- | httemplate/docs/overview-new.dia | bin | 0 -> 2422 bytes | |||
| -rw-r--r-- | httemplate/docs/overview-new.png | bin | 0 -> 29062 bytes | |||
| -rw-r--r-- | httemplate/docs/overview.dia | bin | 0 -> 2800 bytes | |||
| -rw-r--r-- | httemplate/docs/overview.png | bin | 0 -> 13064 bytes | |||
| -rwxr-xr-x | httemplate/docs/passwd.html | 23 | ||||
| -rw-r--r-- | httemplate/docs/schema.dia | bin | 0 -> 16364 bytes | |||
| -rw-r--r-- | httemplate/docs/schema.html | 533 | ||||
| -rw-r--r-- | httemplate/docs/schema.png | bin | 0 -> 681043 bytes | |||
| -rw-r--r-- | httemplate/docs/session.html | 59 | ||||
| -rw-r--r-- | httemplate/docs/signup.html | 54 | ||||
| -rwxr-xr-x | httemplate/docs/ssh.html | 16 |
22 files changed, 1922 insertions, 0 deletions
diff --git a/httemplate/docs/AGPL.html b/httemplate/docs/AGPL.html new file mode 100644 index 000000000..f55bebb16 --- /dev/null +++ b/httemplate/docs/AGPL.html @@ -0,0 +1,672 @@ +<h3 style="text-align: center;">GNU AFFERO GENERAL PUBLIC LICENSE</h3> +<p style="text-align: center;">Version 3, 19 November 2007</p> + +<p>Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/> + <br> + Everyone is permitted to copy and distribute verbatim copies + of this license document, but changing it is not allowed.</p> + +<h3>Preamble</h3> + +<p>The GNU Affero General Public License is a free, copyleft license +for software and other kinds of works, specifically designed to ensure +cooperation with the community in the case of network server software.</p> + +<p>The licenses for most software and other practical works are +designed to take away your freedom to share and change the works. By +contrast, our General Public Licenses are intended to guarantee your +freedom to share and change all versions of a program--to make sure it +remains free software for all its users.</p> + +<p>When we speak of free software, we are referring to freedom, not +price. Our General Public Licenses are designed to make sure that you +have the freedom to distribute copies of free software (and charge for +them if you wish), that you receive source code or can get it if you +want it, that you can change the software or use pieces of it in new +free programs, and that you know you can do these things.</p> + +<p>Developers that use our General Public Licenses protect your rights +with two steps: (1) assert copyright on the software, and (2) offer +you this License which gives you legal permission to copy, distribute +and/or modify the software.</p> + +<p>A secondary benefit of defending all users' freedom is that +improvements made in alternate versions of the program, if they +receive widespread use, become available for other developers to +incorporate. Many developers of free software are heartened and +encouraged by the resulting cooperation. However, in the case of +software used on network servers, this result may fail to come about. +The GNU General Public License permits making a modified version and +letting the public access it on a server without ever releasing its +source code to the public.</p> + +<p>The GNU Affero General Public License is designed specifically to +ensure that, in such cases, the modified source code becomes available +to the community. It requires the operator of a network server to +provide the source code of the modified version running there to the +users of that server. Therefore, public use of a modified version, on +a publicly accessible server, gives the public access to the source +code of the modified version.</p> + +<p>An older license, called the Affero General Public License and +published by Affero, was designed to accomplish similar goals. This is +a different license, not a version of the Affero GPL, but Affero has +released a new version of the Affero GPL which permits relicensing under +this license.</p> + +<p>The precise terms and conditions for copying, distribution and +modification follow.</p> + +<h3>TERMS AND CONDITIONS</h3> + +<h4>0. Definitions.</h4> + +<p>"This License" refers to version 3 of the GNU Affero General Public +License.</p> + +<p>"Copyright" also means copyright-like laws that apply to other kinds +of works, such as semiconductor masks.</p> + +<p>"The Program" refers to any copyrightable work licensed under this +License. Each licensee is addressed as "you". "Licensees" and +"recipients" may be individuals or organizations.</p> + +<p>To "modify" a work means to copy from or adapt all or part of the work +in a fashion requiring copyright permission, other than the making of an +exact copy. The resulting work is called a "modified version" of the +earlier work or a work "based on" the earlier work.</p> + +<p>A "covered work" means either the unmodified Program or a work based +on the Program.</p> + +<p>To "propagate" a work means to do anything with it that, without +permission, would make you directly or secondarily liable for +infringement under applicable copyright law, except executing it on a +computer or modifying a private copy. Propagation includes copying, +distribution (with or without modification), making available to the +public, and in some countries other activities as well.</p> + +<p>To "convey" a work means any kind of propagation that enables other +parties to make or receive copies. Mere interaction with a user through +a computer network, with no transfer of a copy, is not conveying.</p> + +<p>An interactive user interface displays "Appropriate Legal Notices" +to the extent that it includes a convenient and prominently visible +feature that (1) displays an appropriate copyright notice, and (2) +tells the user that there is no warranty for the work (except to the +extent that warranties are provided), that licensees may convey the +work under this License, and how to view a copy of this License. If +the interface presents a list of user commands or options, such as a +menu, a prominent item in the list meets this criterion.</p> + +<h4>1. Source Code.</h4> + +<p>The "source code" for a work means the preferred form of the work +for making modifications to it. "Object code" means any non-source +form of a work.</p> + +<p>A "Standard Interface" means an interface that either is an official +standard defined by a recognized standards body, or, in the case of +interfaces specified for a particular programming language, one that +is widely used among developers working in that language.</p> + +<p>The "System Libraries" of an executable work include anything, other +than the work as a whole, that (a) is included in the normal form of +packaging a Major Component, but which is not part of that Major +Component, and (b) serves only to enable use of the work with that +Major Component, or to implement a Standard Interface for which an +implementation is available to the public in source code form. A +"Major Component", in this context, means a major essential component +(kernel, window system, and so on) of the specific operating system +(if any) on which the executable work runs, or a compiler used to +produce the work, or an object code interpreter used to run it.</p> + +<p>The "Corresponding Source" for a work in object code form means all +the source code needed to generate, install, and (for an executable +work) run the object code and to modify the work, including scripts to +control those activities. However, it does not include the work's +System Libraries, or general-purpose tools or generally available free +programs which are used unmodified in performing those activities but +which are not part of the work. For example, Corresponding Source +includes interface definition files associated with source files for +the work, and the source code for shared libraries and dynamically +linked subprograms that the work is specifically designed to require, +such as by intimate data communication or control flow between those +subprograms and other parts of the work.</p> + +<p>The Corresponding Source need not include anything that users +can regenerate automatically from other parts of the Corresponding +Source.</p> + +<p>The Corresponding Source for a work in source code form is that +same work.</p> + +<h4>2. Basic Permissions.</h4> + +<p>All rights granted under this License are granted for the term of +copyright on the Program, and are irrevocable provided the stated +conditions are met. This License explicitly affirms your unlimited +permission to run the unmodified Program. The output from running a +covered work is covered by this License only if the output, given its +content, constitutes a covered work. This License acknowledges your +rights of fair use or other equivalent, as provided by copyright law.</p> + +<p>You may make, run and propagate covered works that you do not +convey, without conditions so long as your license otherwise remains +in force. You may convey covered works to others for the sole purpose +of having them make modifications exclusively for you, or provide you +with facilities for running those works, provided that you comply with +the terms of this License in conveying all material for which you do +not control copyright. Those thus making or running the covered works +for you must do so exclusively on your behalf, under your direction +and control, on terms that prohibit them from making any copies of +your copyrighted material outside their relationship with you.</p> + +<p>Conveying under any other circumstances is permitted solely under +the conditions stated below. Sublicensing is not allowed; section 10 +makes it unnecessary.</p> + +<h4>3. Protecting Users' Legal Rights From Anti-Circumvention Law.</h4> + +<p>No covered work shall be deemed part of an effective technological +measure under any applicable law fulfilling obligations under article +11 of the WIPO copyright treaty adopted on 20 December 1996, or +similar laws prohibiting or restricting circumvention of such +measures.</p> + +<p>When you convey a covered work, you waive any legal power to forbid +circumvention of technological measures to the extent such circumvention +is effected by exercising rights under this License with respect to +the covered work, and you disclaim any intention to limit operation or +modification of the work as a means of enforcing, against the work's +users, your or third parties' legal rights to forbid circumvention of +technological measures.</p> + +<h4>4. Conveying Verbatim Copies.</h4> + +<p>You may convey verbatim copies of the Program's source code as you +receive it, in any medium, provided that you conspicuously and +appropriately publish on each copy an appropriate copyright notice; +keep intact all notices stating that this License and any +non-permissive terms added in accord with section 7 apply to the code; +keep intact all notices of the absence of any warranty; and give all +recipients a copy of this License along with the Program.</p> + +<p>You may charge any price or no price for each copy that you convey, +and you may offer support or warranty protection for a fee.</p> + +<h4>5. Conveying Modified Source Versions.</h4> + +<p>You may convey a work based on the Program, or the modifications to +produce it from the Program, in the form of source code under the +terms of section 4, provided that you also meet all of these conditions:</p> + +<ul> +<li>a) The work must carry prominent notices stating that you modified + it, and giving a relevant date.</li> + +<li>b) The work must carry prominent notices stating that it is + released under this License and any conditions added under section + 7. This requirement modifies the requirement in section 4 to + "keep intact all notices".</li> + +<li>c) You must license the entire work, as a whole, under this + License to anyone who comes into possession of a copy. This + License will therefore apply, along with any applicable section 7 + additional terms, to the whole of the work, and all its parts, + regardless of how they are packaged. This License gives no + permission to license the work in any other way, but it does not + invalidate such permission if you have separately received it.</li> + +<li>d) If the work has interactive user interfaces, each must display + Appropriate Legal Notices; however, if the Program has interactive + interfaces that do not display Appropriate Legal Notices, your + work need not make them do so.</li> + +</ul> +<p>A compilation of a covered work with other separate and independent +works, which are not by their nature extensions of the covered work, +and which are not combined with it such as to form a larger program, +in or on a volume of a storage or distribution medium, is called an +"aggregate" if the compilation and its resulting copyright are not +used to limit the access or legal rights of the compilation's users +beyond what the individual works permit. Inclusion of a covered work +in an aggregate does not cause this License to apply to the other +parts of the aggregate.</p> + +<h4>6. Conveying Non-Source Forms.</h4> + +<p>You may convey a covered work in object code form under the terms +of sections 4 and 5, provided that you also convey the +machine-readable Corresponding Source under the terms of this License, +in one of these ways:</p> + +<ul> +<li>a) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by the + Corresponding Source fixed on a durable physical medium + customarily used for software interchange.</li> + +<li>b) Convey the object code in, or embodied in, a physical product + (including a physical distribution medium), accompanied by a + written offer, valid for at least three years and valid for as + long as you offer spare parts or customer support for that product + model, to give anyone who possesses the object code either (1) a + copy of the Corresponding Source for all the software in the + product that is covered by this License, on a durable physical + medium customarily used for software interchange, for a price no + more than your reasonable cost of physically performing this + conveying of source, or (2) access to copy the + Corresponding Source from a network server at no charge.</li> + +<li>c) Convey individual copies of the object code with a copy of the + written offer to provide the Corresponding Source. This + alternative is allowed only occasionally and noncommercially, and + only if you received the object code with such an offer, in accord + with subsection 6b.</li> + +<li>d) Convey the object code by offering access from a designated + place (gratis or for a charge), and offer equivalent access to the + Corresponding Source in the same way through the same place at no + further charge. You need not require recipients to copy the + Corresponding Source along with the object code. If the place to + copy the object code is a network server, the Corresponding Source + may be on a different server (operated by you or a third party) + that supports equivalent copying facilities, provided you maintain + clear directions next to the object code saying where to find the + Corresponding Source. Regardless of what server hosts the + Corresponding Source, you remain obligated to ensure that it is + available for as long as needed to satisfy these requirements.</li> + +<li>e) Convey the object code using peer-to-peer transmission, provided + you inform other peers where the object code and Corresponding + Source of the work are being offered to the general public at no + charge under subsection 6d.</li> + +</ul> +<p>A separable portion of the object code, whose source code is excluded +from the Corresponding Source as a System Library, need not be +included in conveying the object code work.</p> + +<p>A "User Product" is either (1) a "consumer product", which means any +tangible personal property which is normally used for personal, family, +or household purposes, or (2) anything designed or sold for incorporation +into a dwelling. In determining whether a product is a consumer product, +doubtful cases shall be resolved in favor of coverage. For a particular +product received by a particular user, "normally used" refers to a +typical or common use of that class of product, regardless of the status +of the particular user or of the way in which the particular user +actually uses, or expects or is expected to use, the product. A product +is a consumer product regardless of whether the product has substantial +commercial, industrial or non-consumer uses, unless such uses represent +the only significant mode of use of the product.</p> + +<p>"Installation Information" for a User Product means any methods, +procedures, authorization keys, or other information required to install +and execute modified versions of a covered work in that User Product from +a modified version of its Corresponding Source. The information must +suffice to ensure that the continued functioning of the modified object +code is in no case prevented or interfered with solely because +modification has been made.</p> + +<p>If you convey an object code work under this section in, or with, or +specifically for use in, a User Product, and the conveying occurs as +part of a transaction in which the right of possession and use of the +User Product is transferred to the recipient in perpetuity or for a +fixed term (regardless of how the transaction is characterized), the +Corresponding Source conveyed under this section must be accompanied +by the Installation Information. But this requirement does not apply +if neither you nor any third party retains the ability to install +modified object code on the User Product (for example, the work has +been installed in ROM).</p> + +<p>The requirement to provide Installation Information does not include a +requirement to continue to provide support service, warranty, or updates +for a work that has been modified or installed by the recipient, or for +the User Product in which it has been modified or installed. Access to a +network may be denied when the modification itself materially and +adversely affects the operation of the network or violates the rules and +protocols for communication across the network.</p> + +<p>Corresponding Source conveyed, and Installation Information provided, +in accord with this section must be in a format that is publicly +documented (and with an implementation available to the public in +source code form), and must require no special password or key for +unpacking, reading or copying.</p> + +<h4>7. Additional Terms.</h4> + +<p>"Additional permissions" are terms that supplement the terms of this +License by making exceptions from one or more of its conditions. +Additional permissions that are applicable to the entire Program shall +be treated as though they were included in this License, to the extent +that they are valid under applicable law. If additional permissions +apply only to part of the Program, that part may be used separately +under those permissions, but the entire Program remains governed by +this License without regard to the additional permissions.</p> + +<p>When you convey a copy of a covered work, you may at your option +remove any additional permissions from that copy, or from any part of +it. (Additional permissions may be written to require their own +removal in certain cases when you modify the work.) You may place +additional permissions on material, added by you to a covered work, +for which you have or can give appropriate copyright permission.</p> + +<p>Notwithstanding any other provision of this License, for material you +add to a covered work, you may (if authorized by the copyright holders of +that material) supplement the terms of this License with terms:</p> + +<ul> +<li>a) Disclaiming warranty or limiting liability differently from the + terms of sections 15 and 16 of this License; or</li> + +<li>b) Requiring preservation of specified reasonable legal notices or + author attributions in that material or in the Appropriate Legal + Notices displayed by works containing it; or</li> + +<li>c) Prohibiting misrepresentation of the origin of that material, or + requiring that modified versions of such material be marked in + reasonable ways as different from the original version; or</li> + +<li>d) Limiting the use for publicity purposes of names of licensors or + authors of the material; or</li> + +<li>e) Declining to grant rights under trademark law for use of some + trade names, trademarks, or service marks; or</li> + +<li>f) Requiring indemnification of licensors and authors of that + material by anyone who conveys the material (or modified versions of + it) with contractual assumptions of liability to the recipient, for + any liability that these contractual assumptions directly impose on + those licensors and authors.</li> + +</ul> +<p>All other non-permissive additional terms are considered "further +restrictions" within the meaning of section 10. If the Program as you +received it, or any part of it, contains a notice stating that it is +governed by this License along with a term that is a further restriction, +you may remove that term. If a license document contains a further +restriction but permits relicensing or conveying under this License, you +may add to a covered work material governed by the terms of that license +document, provided that the further restriction does not survive such +relicensing or conveying.</p> + +<p>If you add terms to a covered work in accord with this section, you +must place, in the relevant source files, a statement of the +additional terms that apply to those files, or a notice indicating +where to find the applicable terms.</p> + +<p>Additional terms, permissive or non-permissive, may be stated in the +form of a separately written license, or stated as exceptions; +the above requirements apply either way.</p> + +<h4>8. Termination.</h4> + +<p>You may not propagate or modify a covered work except as expressly +provided under this License. Any attempt otherwise to propagate or +modify it is void, and will automatically terminate your rights under +this License (including any patent licenses granted under the third +paragraph of section 11).</p> + +<p>However, if you cease all violation of this License, then your +license from a particular copyright holder is reinstated (a) +provisionally, unless and until the copyright holder explicitly and +finally terminates your license, and (b) permanently, if the copyright +holder fails to notify you of the violation by some reasonable means +prior to 60 days after the cessation.</p> + +<p>Moreover, your license from a particular copyright holder is +reinstated permanently if the copyright holder notifies you of the +violation by some reasonable means, this is the first time you have +received notice of violation of this License (for any work) from that +copyright holder, and you cure the violation prior to 30 days after +your receipt of the notice.</p> + +<p>Termination of your rights under this section does not terminate the +licenses of parties who have received copies or rights from you under +this License. If your rights have been terminated and not permanently +reinstated, you do not qualify to receive new licenses for the same +material under section 10.</p> + +<h4>9. Acceptance Not Required for Having Copies.</h4> + +<p>You are not required to accept this License in order to receive or +run a copy of the Program. Ancillary propagation of a covered work +occurring solely as a consequence of using peer-to-peer transmission +to receive a copy likewise does not require acceptance. However, +nothing other than this License grants you permission to propagate or +modify any covered work. These actions infringe copyright if you do +not accept this License. Therefore, by modifying or propagating a +covered work, you indicate your acceptance of this License to do so.</p> + +<h4>10. Automatic Licensing of Downstream Recipients.</h4> + +<p>Each time you convey a covered work, the recipient automatically +receives a license from the original licensors, to run, modify and +propagate that work, subject to this License. You are not responsible +for enforcing compliance by third parties with this License.</p> + +<p>An "entity transaction" is a transaction transferring control of an +organization, or substantially all assets of one, or subdividing an +organization, or merging organizations. If propagation of a covered +work results from an entity transaction, each party to that +transaction who receives a copy of the work also receives whatever +licenses to the work the party's predecessor in interest had or could +give under the previous paragraph, plus a right to possession of the +Corresponding Source of the work from the predecessor in interest, if +the predecessor has it or can get it with reasonable efforts.</p> + +<p>You may not impose any further restrictions on the exercise of the +rights granted or affirmed under this License. For example, you may +not impose a license fee, royalty, or other charge for exercise of +rights granted under this License, and you may not initiate litigation +(including a cross-claim or counterclaim in a lawsuit) alleging that +any patent claim is infringed by making, using, selling, offering for +sale, or importing the Program or any portion of it.</p> + +<h4>11. Patents.</h4> + +<p>A "contributor" is a copyright holder who authorizes use under this +License of the Program or a work on which the Program is based. The +work thus licensed is called the contributor's "contributor version".</p> + +<p>A contributor's "essential patent claims" are all patent claims +owned or controlled by the contributor, whether already acquired or +hereafter acquired, that would be infringed by some manner, permitted +by this License, of making, using, or selling its contributor version, +but do not include claims that would be infringed only as a +consequence of further modification of the contributor version. For +purposes of this definition, "control" includes the right to grant +patent sublicenses in a manner consistent with the requirements of +this License.</p> + +<p>Each contributor grants you a non-exclusive, worldwide, royalty-free +patent license under the contributor's essential patent claims, to +make, use, sell, offer for sale, import and otherwise run, modify and +propagate the contents of its contributor version.</p> + +<p>In the following three paragraphs, a "patent license" is any express +agreement or commitment, however denominated, not to enforce a patent +(such as an express permission to practice a patent or covenant not to +sue for patent infringement). To "grant" such a patent license to a +party means to make such an agreement or commitment not to enforce a +patent against the party.</p> + +<p>If you convey a covered work, knowingly relying on a patent license, +and the Corresponding Source of the work is not available for anyone +to copy, free of charge and under the terms of this License, through a +publicly available network server or other readily accessible means, +then you must either (1) cause the Corresponding Source to be so +available, or (2) arrange to deprive yourself of the benefit of the +patent license for this particular work, or (3) arrange, in a manner +consistent with the requirements of this License, to extend the patent +license to downstream recipients. "Knowingly relying" means you have +actual knowledge that, but for the patent license, your conveying the +covered work in a country, or your recipient's use of the covered work +in a country, would infringe one or more identifiable patents in that +country that you have reason to believe are valid.</p> + +<p>If, pursuant to or in connection with a single transaction or +arrangement, you convey, or propagate by procuring conveyance of, a +covered work, and grant a patent license to some of the parties +receiving the covered work authorizing them to use, propagate, modify +or convey a specific copy of the covered work, then the patent license +you grant is automatically extended to all recipients of the covered +work and works based on it.</p> + +<p>A patent license is "discriminatory" if it does not include within +the scope of its coverage, prohibits the exercise of, or is +conditioned on the non-exercise of one or more of the rights that are +specifically granted under this License. You may not convey a covered +work if you are a party to an arrangement with a third party that is +in the business of distributing software, under which you make payment +to the third party based on the extent of your activity of conveying +the work, and under which the third party grants, to any of the +parties who would receive the covered work from you, a discriminatory +patent license (a) in connection with copies of the covered work +conveyed by you (or copies made from those copies), or (b) primarily +for and in connection with specific products or compilations that +contain the covered work, unless you entered into that arrangement, +or that patent license was granted, prior to 28 March 2007.</p> + +<p>Nothing in this License shall be construed as excluding or limiting +any implied license or other defenses to infringement that may +otherwise be available to you under applicable patent law.</p> + +<h4>12. No Surrender of Others' Freedom.</h4> + +<p>If conditions are imposed on you (whether by court order, agreement or +otherwise) that contradict the conditions of this License, they do not +excuse you from the conditions of this License. If you cannot convey a +covered work so as to satisfy simultaneously your obligations under this +License and any other pertinent obligations, then as a consequence you may +not convey it at all. For example, if you agree to terms that obligate you +to collect a royalty for further conveying from those to whom you convey +the Program, the only way you could satisfy both those terms and this +License would be to refrain entirely from conveying the Program.</p> + +<h4>13. Remote Network Interaction; Use with the GNU General Public License.</h4> + +<p>Notwithstanding any other provision of this License, if you modify the +Program, your modified version must prominently offer all users +interacting with it remotely through a computer network (if your version +supports such interaction) an opportunity to receive the Corresponding +Source of your version by providing access to the Corresponding Source +from a network server at no charge, through some standard or customary +means of facilitating copying of software. This Corresponding Source +shall include the Corresponding Source for any work covered by version 3 +of the GNU General Public License that is incorporated pursuant to the +following paragraph.</p> + +<p>Notwithstanding any other provision of this License, you have permission +to link or combine any covered work with a work licensed under version 3 +of the GNU General Public License into a single combined work, and to +convey the resulting work. The terms of this License will continue to +apply to the part which is the covered work, but the work with which it is +combined will remain governed by version 3 of the GNU General Public +License.</p> + +<h4>14. Revised Versions of this License.</h4> + +<p>The Free Software Foundation may publish revised and/or new versions of +the GNU Affero General Public License from time to time. Such new +versions will be similar in spirit to the present version, but may differ +in detail to address new problems or concerns.</p> + +<p>Each version is given a distinguishing version number. If the +Program specifies that a certain numbered version of the GNU Affero +General Public License "or any later version" applies to it, you have +the option of following the terms and conditions either of that +numbered version or of any later version published by the Free +Software Foundation. If the Program does not specify a version number +of the GNU Affero General Public License, you may choose any version +ever published by the Free Software Foundation.</p> + +<p>If the Program specifies that a proxy can decide which future +versions of the GNU Affero General Public License can be used, that +proxy's public statement of acceptance of a version permanently +authorizes you to choose that version for the Program.</p> + +<p>Later license versions may give you additional or different +permissions. However, no additional obligations are imposed on any +author or copyright holder as a result of your choosing to follow a +later version.</p> + +<h4>15. Disclaimer of Warranty.</h4> + +<p>THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY +APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT +HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY +OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, +THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR +PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM +IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF +ALL NECESSARY SERVICING, REPAIR OR CORRECTION.</p> + +<h4>16. Limitation of Liability.</h4> + +<p>IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING +WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS +THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY +GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE +USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF +DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD +PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), +EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF +SUCH DAMAGES.</p> + +<h4>17. Interpretation of Sections 15 and 16.</h4> + +<p>If the disclaimer of warranty and limitation of liability provided +above cannot be given local legal effect according to their terms, +reviewing courts shall apply local law that most closely approximates +an absolute waiver of all civil liability in connection with the +Program, unless a warranty or assumption of liability accompanies a +copy of the Program in return for a fee.</p> + +<p>END OF TERMS AND CONDITIONS</p> + +<h3>How to Apply These Terms to Your New Programs</h3> + +<p>If you develop a new program, and you want it to be of the greatest +possible use to the public, the best way to achieve this is to make it +free software which everyone can redistribute and change under these terms.</p> + +<p>To do so, attach the following notices to the program. It is safest +to attach them to the start of each source file to most effectively +state the exclusion of warranty; and each file should have at least +the "copyright" line and a pointer to where the full notice is found.</p> + +<pre> <one line to give the program's name and a brief idea of what it does.> + Copyright (C) <year> <name of author> + + This program is free software: you can redistribute it and/or modify + it under the terms of the GNU Affero General Public License as + published by the Free Software Foundation, either version 3 of the + License, or (at your option) any later version. + + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + + You should have received a copy of the GNU Affero General Public License + along with this program. If not, see <http://www.gnu.org/licenses/>. +</pre> + +<p>Also add information on how to contact you by electronic and paper mail.</p> + +<p>If your software can interact with users remotely through a computer +network, you should also make sure that it provides a way for users to +get its source. For example, if your program is a web application, its +interface could display a "Source" link that leads users to an archive +of the code. There are many ways you could offer source, and different +solutions will be better for different programs; see section 13 for the +specific requirements.</p> + +<p>You should also get your employer (if you work as a programmer) or school, +if any, to sign a "copyright disclaimer" for the program, if necessary. +For more information on this, and how to apply and follow the GNU AGPL, see +<http://www.gnu.org/licenses/>. +</p> + diff --git a/httemplate/docs/about.html b/httemplate/docs/about.html new file mode 100644 index 000000000..dee424776 --- /dev/null +++ b/httemplate/docs/about.html @@ -0,0 +1,53 @@ +<% include('/elements/header-popup.html', 'Freeside') %> + +<% include('/elements/init_overlib.html') %> + +<CENTER> +<IMG SRC="<%$fsurl%>images/small-logo.png" BORDER=0"><BR> +<H3>version <% $FS::VERSION %></H3> +</CENTER> + +<CENTER> +<FONT SIZE="-1">© 2008 Freeside Internet Services, Inc.<BR> +All rights reserved.<BR> +Licensed under the terms of the<BR> +GNU <i>Affero</i> General Public License.<BR> +</FONT> +</CENTER> +<BR> + +<CENTER> +<A HREF="credits.html">Credits</A> + +<A HREF="javascript:void(0)" onClick="openLicense()">License</A> + + +<BR><BR> +<A HREF="http://www.freeside.biz/freeside" TARGET="_blank">Freeside homepage</A> +</CENTER> + +<BR> + +<CENTER> +<FONT SIZE="-3">"I need a miracle every day." -J.P. Barlow</FONT> +</CENTER> + +<SCRIPT TYPE="text/javascript"> + +function openLicense() { + parent.<% include('/elements/popup_link_onclick.html', + 'action' => $fsurl.'docs/license.html', + 'label' => 'License', + 'actionlabel' => 'License', + 'width' => 600, + 'height' => 360, + 'color' => '#7e0079', + 'nofalse' => 1, + ) + %> +} + +</SCRIPT> + +</BODY> +</HTML> diff --git a/httemplate/docs/ach.html b/httemplate/docs/ach.html new file mode 100644 index 000000000..b8a17c87d --- /dev/null +++ b/httemplate/docs/ach.html @@ -0,0 +1,10 @@ +<HTML> + <HEAD> + <TITLE> + Electronic check (ACH) information + </TITLE> + </HEAD> + <BODY BGCOLOR="#ffffff"> + <IMG BORDER=0 SRC="../images/ach.png"> + </BODY> +</HTML> diff --git a/httemplate/docs/admin.html b/httemplate/docs/admin.html new file mode 100755 index 000000000..2aa934812 --- /dev/null +++ b/httemplate/docs/admin.html @@ -0,0 +1,41 @@ +<head> + <title>Administration</title> +</head> +<body> + <h1>Administration</h1> +</body> +<ul> + <li>Open up the root of the Freeside document tree in your web + browser. For example, if you created the Freeside document tree in + /home/httpd/html/freeside, and your web browser's DocumentRoot is + /home/httpd/html, open https://your_host/freeside/. Replace + "your_host" with the name or network address of your web server. + <li>Select <u>Configuration</u> from the main menu and update your configuration values. + + <li>Go to <u>View/Edit service definitions</u> on the main menu, and + <u>Add a new service definition</u> with <i>Table</i> <b>svc_acct</b>. + Select your domain in the <b>domsvc</b> Modifier. Set <b>Fixed</b> to define + a service locked-in to this domain, or <b>Default</b> to define a service + which may select from among this domain and the customer's domains. + + <li><table><tr> + <td> Create at least POP (Point of Presence) by selecting + <u>View/Edit POPs</u> from the main menu.</td> + <th align="left"> OR </th> + <td>If you are not doing dialup, set slipip to fixed and blank for all your + Service Definitions which have Table <b>svc_acct</b>.</td> + </tr></table> + + <li>If you are using Freeside to keep track of sales taxes, define tax + information for your locales by clicking on the <u>View/Edit locales and tax + rates</u> on the main menu. + + <li>If you would like Freeside to notify your customers when their credit + cards and other billing arrangements are about to expire, arrange for + <b>freeside-expiration-alerter</b> to be run daily by cron or similar + facility. The message it sends can be configured from the + <u>Configuration</u> choice of the main menu as <u>alerter_template</u>. + +</ul> +</body> +</html> diff --git a/httemplate/docs/credits.html b/httemplate/docs/credits.html new file mode 100644 index 000000000..3c5564da3 --- /dev/null +++ b/httemplate/docs/credits.html @@ -0,0 +1,175 @@ +<% include('/elements/header-popup.html', '') %> + +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> + +<FONT SIZE=6> + <CENTER>Freeside</CENTER> +</FONT> + +<BR> + +<CENTER> +<IMG SRC="<%$fsurl%>images/small-logo.png" BORDER=0"><BR> +<H3>version <% $FS::VERSION %></H3> +</CENTER> + +<CENTER> + +<H3>Core team</H3> +Peter Bowen<BR> +Jeff Finucane<BR> +Jason Hall<BR> +Kristian Hoffman<BR> +Ivan Kohler<BR> +Richard Siddall<BR> +<BR> + +<H3>Contributors</H3> +Stephen Amadei<BR> +Eric Arvidsson<BR> +Mark Asplen-Taylor<BR> +Mihai Bazon<BR> +Charles A. Beasley<BR> +Stephen Bechard<BR> +Eric Bosrup<BR> +Dave Burgess<BR> +Joe Camadine<BR> +Chris Cappuccio<BR> +Rebecca Cardennis<BR> +Shane Chrisp<BR> +Luke Crawford<BR> +Brad Dameron<BR> +Dave Denney<BR> +Serge Dolgov<BR> +Scott Edwards<BR> +Kenny Elliott<BR> +Donald Greer<BR> +Joel Griffiths<BR> +Ryan Gunn<BR> +Troy Hammonds<BR> +Sean Hanson<BR> +Dale Hege<BR> +Kelly Hickel<BR> +Mark James<BR> +Frederico Caldeira Knabben<BR> +Greg Kuhnert<BR> +Randall Lucas<BR> +Foteos Macrides<BR> +Roger Mangraviti<BR> +Brian McCane<BR> +mimooh<BR> +Mack Nagashima<BR> +Matt Peterson<BR> +Luke Pfeifer<BR> +Ricardo Signes<BR> +Matt Simerson<BR> +Steve Simitzis<BR> +Jason Spence<BR> +James Switzer<BR> +Audrey Tang<BR> +Jason Thomas<BR> +Jesse Vincent<BR> +Mark Wells<BR> +Peter Wemm<BR> +Mark Williamson<BR> +Tim Yardley<BR> + +</CENTER> + +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> +<BR> + +<SCRIPT TYPE="text/javascript"> + +function myScroll() { + + documentYposition += 1; + window.scroll(0,documentYposition); + + var timeout = 25; + + if ( documentYposition > documentLength ) { + documentYposition = 0; + } + + if ( documentYposition == startingPosition ) { + timeout = 5000; + } + + setTimeout('myScroll()', timeout); +} + +function DelayThenScroll() { + window.scroll(0,documentYposition); + documentLength = myHeight(); + setTimeout('myScroll()', 3000); +} + +function myHeight() { +/* if (document.all) + return document.body.offsetHeight; + else if (document.layers) + return document.body.document.height; + else +*/ + return 1700; // approx height (add more per contributors) +} + +document.body.style.overflow = 'hidden'; + +var startingPosition = 360; + +//huh, adjust for firefox +var ua = navigator.userAgent; +var opera = /opera [56789]|opera\/[56789]/i.test(ua); +var webkit = /webkit/i.test(ua) +var moz = !opera && !webkit && /gecko/i.test(ua); +if ( moz ) { + startingPosition += 20; +} else if ( opera ) { + startingPosition += 21; +} + +var documentYposition = startingPosition; +var documentLength; +window.onLoad = DelayThenScroll(); + +</SCRIPT> + +</BODY> +</HTML> diff --git a/httemplate/docs/cvv2.html b/httemplate/docs/cvv2.html new file mode 100644 index 000000000..767098537 --- /dev/null +++ b/httemplate/docs/cvv2.html @@ -0,0 +1,24 @@ +<HTML> + <HEAD> + <TITLE> + CVV2 information + </TITLE> + </HEAD> + <BODY BGCOLOR="#e8e8e8"> + The CVV2 number (also called CVC2 or CID) is a three- or four-digit + security code used to reduce credit card fraud.<BR><BR> + <TABLE BORDER=0 CELLSPACING=4> + <TR> + <TH>Visa / MasterCard / Discover</TH> + <TH>American Express</TH> + </TR> + <TR> + <TD> + <IMG BORDER=0 ALT="Visa/MasterCard/Discover" SRC="../images/cvv2.png"> + </TD> + <TD> + <IMG BORDER=0 ALT="American Express" SRC="../images/cvv2_amex.png"> + </TD> + </TABLE> + </BODY> +</HTML> diff --git a/httemplate/docs/ieak.html b/httemplate/docs/ieak.html new file mode 100644 index 000000000..00c53423c --- /dev/null +++ b/httemplate/docs/ieak.html @@ -0,0 +1,75 @@ +<pre> +this is incomplete +mostly it should be merged into signup.html and fs_signup/ieak.template + +- download and install the IEAK from + http://www.microsoft.com/windows/ieak/default.asp + +- Good examples may be found in + C:\Program Files\IEAK\toolkit\isp\server\ICW\signup\perl\signup08.pl + C:\Program Files\IEAK\toolkit\isp\server\ICW\reconfig\perl\reconfig04.pl + C:\Program Files\IEAK6\toolkit\isp\servless\basic\sample.ins + C:\Program Files\IEAK6\toolkit\isp\servless\advanced\4567.ins + C:\Program Files\IEAK6\toolkit\isp\servless\advanced\4568.ins + C:\Program Files\IEAK6\toolkit\isp\servless\advanced\7890.ins + C:\Program Files\IEAK6\toolkit\isp\servless\advanced\7891.ins + +- Full documentation on all the settings available in .INS files is + avaialble under Program Files | Microsoft IEAK 6 | IEAK Help + | Reference | Internet Settings (.ins) Files + +- Freeside will make the following substitutions before sending the file + to the user: + + { $ac } - area code of selected POP + { $exch } - exchange of selected POP + { $loc } - local part of selected POP + { $username } + { $password } + { $email_name } - first and last name + { $pkg } - package name + +- Simple example follows: + +[Entry] +Entry Name = IEAK Sample +[Phone] +Dial_As_Is = No +Phone_Number = { $exch }{ $loc } +Area_Code = { $ac } +Country_Code = 1 +Country_Id = 1 +[Server] +Type = PPP +SW_Compress = Yes +PW_Encrypt = Yes +Negotiate_TCP/IP = Yes +Disable_LCP = No +[TCP/IP] +Specity_IP_Address = No +Specity_Server_Address = No +IP_Header_Compress = Yes +Gateway_On_Remote = Yes +[User] +Name = { $username } +Passowrd = { $password } +Display_Password = Yes +[Internet_Mail] +Email_Name = { $email_name } +Email_Address = { $username }@example.com +POP_Server = mail.example.com +POP_Server_Port_Number = 110 +POP_Logon_Password = { $password } +SMTP_Server = mail.example.com +SMTP_Server_Port_Number = 25 +Install_Mail = 1 +[URL] +Help_Page = http://www.ieaksample.net/helpdesk +Home_Page = http://www.ieaksample.net +Search_Page = http://www.ieaksample,net/search +[Favorites] +IEAK Sample \\ IEAK Sample Home Page.url = http://acme.ieaksample.net/ +[Branding] +Window_Title = Internet Explorer from Acme Internet Services + +</pre> diff --git a/httemplate/docs/index.html b/httemplate/docs/index.html new file mode 100644 index 000000000..3b419de00 --- /dev/null +++ b/httemplate/docs/index.html @@ -0,0 +1,32 @@ +<head> + <title>Freeside Documentation</title> +</head> +<body bgcolor="#ffffff"> + <h1>Freeside Documentation</h1> +<img src="overview-new.png"> +<h3>Installation and upgrades</h3> +<ul> + <li><a href="http://www.sisd.com/mediawiki/index.php/Freeside:1.7:Documentation:Installation">New Installation</a> + <li><a href="http://www.sisd.com/mediawiki/index.php/Freeside:1.7:Documentation:RT_Installation">Installing integrated RT ticketing</a> + <li><a href="http://www.sisd.com/mediawiki/index.php/Freeside:1.7:Documentation:Self-Service_Installation">Signup/Self-service installation</a> + <li><a href="http://www.sisd.com/mediawiki/index.php/Freeside:1.7:Documentation:Upgrading">Upgrading from 1.5.8 or 1.6.X</a> +</ul> +<h3>Configuration and setup</h3> +<ul> +<!-- + <li><a href="config.html">Configuration files</a> +!--> + <li><a href="admin.html">Administration</a> +<!-- + <li><a href="../index.html#admin">Administration</a> +!--> + <li><a href="http://www.sisd.com/mediawiki/index.php/Freeside:1.7:Documentation:Administration#Exports_.28provisioning.29">Exports</a> + <li><a href="http://www.sisd.com/mediawiki/index.php/Freeside:1.7:Documentation:Administration#Billing">Billing</a> +</ul> +<h3>Developer</h3> +<ul> + <li><a href="schema.html">Schema reference</a> + <li><a href="man/FS.html">Perl API</a> + <li><a href="legacy.html">Importing legacy data</a> +</ul> +</body> diff --git a/httemplate/docs/legacy.html b/httemplate/docs/legacy.html new file mode 100755 index 000000000..94efe53af --- /dev/null +++ b/httemplate/docs/legacy.html @@ -0,0 +1,39 @@ +<head> + <title>Importing legacy data</title> +</head> +<body> + <h1>Importing legacy data</h1> +<font size="+2">In almost all cases, legacy data import will require writing custom code to deal with your particular legacy data. The example scripts here will probably <b>not</b> work "out-of-the-box", and are provided <b>as a starting point only</b>.</font> +<br><br><i>Some import scripts may require installation of the <a href="http://search.cpan.org/search?dist=Array-PrintCols">Array-PrintCols</a> and <a href="http://search.cpan.org/search?dist=Term-Query">Term-Query</a> (make test broken; install manually) modules.</i><br> +<ul> + <li><a name="bind">bin/bind.import</a> - Import domain information from BIND named + <li><a name="passwd">bin/passwd.import</a> - Just import `passwd' and `shadow' or `master.passwd', no RADIUS import. + <li><a name="svc_acct">bin/svc_acct.import</a> - Import `passwd', ( `shadow' or `master.passwd' ) and RADIUS `users'. Before running bin/svc_acct.import, you need <a href="../browse/part_svc.cgi">services</a> (with table svc_acct) as follows: + <ul> + <li>Most accounts probably have entries in passwd and users (with Port-Limit nonexistant or 1) + <li>Some accounts have entries in passwd and users, but with Port-Limit 2 (or more) + <li>Some accounts might have entries in users only (Port-Limit 1) + <li>Some accounts might have entries in users only (Port-Limit >= 2) + <li>POP mail accounts have entries in passwd only, and have a particular shell. + <li>Everything else in passwd is a shell account. + </ul> +<!-- <li><a name="svc_acct_sm">bin/svc_acct_sm.import</a> - Import qmail ( `virtualdomains' and `rcpthosts' ), or sendmail ( `virtusertable' and `sendmail.cw' ) files. Before running bin/svc_acct_sm.import, you need <a href="../browse/part_svc.cgi">services</a> as follows: + <ul> + <li>Domain (table svc_acct) + <li>Mail alias (table svc_acct_sm) + </ul> +--> + <li><a name="cust_main">Importing customer data</a> + <ul> + <li>Manually + <ul> + <li>Add a <a href="../edit/cust_main.cgi">new customer</a> + <li>Add one or more packages for this customer + <li>Enter a package by clicking on the package number + <li>Pick the `Link to existing' option + </ul> + <li>Batch - You will need to write a script to import your particular legacy data. You can use eg/TEMPLATE_cust_main.import as a starting point. + </ul> +</ul> +</body> + diff --git a/httemplate/docs/license.html b/httemplate/docs/license.html new file mode 100644 index 000000000..54537307e --- /dev/null +++ b/httemplate/docs/license.html @@ -0,0 +1,116 @@ +<% include('/elements/header-popup.html', 'Freeside') %> +<CENTER> +<IMG SRC="<%$fsurl%>images/small-logo.png" BORDER=0"><BR> +<H3>version <% $FS::VERSION %></H3> +</CENTER> + +<P> + +Copyright © 2005-2008 Freeside Internet Services, Inc.<BR> +Copyright © 2000-2005 Ivan Kohler<BR> +Copyright © 1999 Silicon Interactive Software Design<BR> +All rights reserved<BR> + +<P> + This program is free software; you can redistribute it and/or modify + it under the terms of the GNU <B>Affero</B> General Public License as published + by the Free Software Foundation, either version 3 of the License, or (at + your option) any later version. + +<P> + This program is distributed in the hope that it will be useful, + but WITHOUT ANY WARRANTY; without even the implied warranty of + MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the + GNU Affero General Public License for more details. + +<P> + You should have received a copy of the GNU Affero General Public + License along with this program, in the file `<A HREF="AGPL.html" TARGET="_blank">AGPL</A>'; if not, + see <<A HREF="http://www.fsf.org/licensing/licenses/agpl-3.0.html" TARGET="_blank"">http://www.fsf.org/licensing/licenses/agpl-3.0.html</a>>. + +<P> + At your option, you may also redistribute and/or modify the files in the + fs_selfservice/ directory (but not the rest of the software) under the + terms of the GNU General Public License as published by the Free Software + Foundation, either version 3 of the License, or (at your option) any later + version. + +<P> + At your option, you may also redistribute and/or modify the + fs_selfservice/php/freeside.class.php file (but not the rest of the + software) under the terms of the GNU Lesser General Public License as + published by the Free Software Foundation, either version 3 of the License, + or (at your option) any later version. + +<!--entire other packages--> + +<P> +Contains "Request Tracker" <http://www.bestpractical.com/rt/> and +"RTx::Extension::ActivityReports" from Best Practical Solutions, licensed under +the terms of the GNU GPL, version two. Best Practical Solutions considers the +Request Tracker software in this case to be "merely aggregated" with Freeside, +and not a "combined work", and as such Request Tracker is distributed only +under the original GPLv2 license. + +<!--important widgets or other "whole" bits--> + +<P> +Latex invoice template based on a template from eBills +<http://ebills.sourceforge.net/> by Mark Asplen-Taylor <mark@asplen.co.uk>, +licensed under the terms fo the GNU GPL. + +<P> +Contains "JS Calendar" <http://dynarch.com/mishoo/calendar.epl> +by Mihai Bazon <mishoo@infoiasi.ro> licensed under the terms of the GNU LGPL. + +<P> +Contains FCKeditor by Frederico Caldeira Knabben, licensed under the terms of +the GNU GPL. + +<P> +Contains XMenu <http://webfx.eae.net/dhtml/xmenu/xmenu.html> +by Erik Arvidsson, licensed under the terms of the GNU GPL. + +<!--RT add-ons--> + +<P> +Contains "RTx::Statistics Package" +<http://wiki.bestpractical.com/view/RT3StatisticsPackage> from Kelly Hickel +<kfh@mqsoftware.com>, licensed under the same terms as Perl (GPL/Artistic). + +<P> +Contains "RTx::WebCronTool" <http://search.cpan.org/dist/RTx-WebCronTool/> from +Audrey Tang, licensed under the same terms as Perl (GPL/Artistic). + +<!--libraries--> + +<P> +Contains the QLIB JavaScript library <http://qlib.quazzle.com/> by +Quazzle.com, Serge Dolgov, licensed under the terms of the GNU GPL. + +<P> +Contains the overlibmws DHTML Popup Library <http://www.macridesweb.com/oltest/> +by Foteos Macrides (derived from overLIB <http://www.bosrup.com/web/overlib/> +by Erik Bosrup), licensed under the terms of the Artistic license +<http://www.macridesweb.com/oltest/license.html>. + +<P> +XMLHttpRequest implementation based on the SAJAX toolkit, licensed under the +terms of the BSD license.<BR> +© 2005 modernmethod, inc<BR> +Perl backend version © 2005 Nathan Schmidt + +<!-- artwork --> + +<P> +Contains public domain artwork from openclipart.org by mimooh and other +authors. + +<P> +Contains icons from +<A HREF="http://famfamfam.com/" TARGET="_blank">famfamfam.com</A> +by Mark James, licensed under the terms of the Creative Commons Attribution +2.5 License. + +</BODY> +</HTML> diff --git a/httemplate/docs/man/FS/part_export/.cvs_is_on_crack b/httemplate/docs/man/FS/part_export/.cvs_is_on_crack new file mode 100644 index 000000000..e69de29bb --- /dev/null +++ b/httemplate/docs/man/FS/part_export/.cvs_is_on_crack diff --git a/httemplate/docs/overview-new.dia b/httemplate/docs/overview-new.dia Binary files differnew file mode 100644 index 000000000..d9989a359 --- /dev/null +++ b/httemplate/docs/overview-new.dia diff --git a/httemplate/docs/overview-new.png b/httemplate/docs/overview-new.png Binary files differnew file mode 100644 index 000000000..bf815463b --- /dev/null +++ b/httemplate/docs/overview-new.png diff --git a/httemplate/docs/overview.dia b/httemplate/docs/overview.dia Binary files differnew file mode 100644 index 000000000..a0e34c30e --- /dev/null +++ b/httemplate/docs/overview.dia diff --git a/httemplate/docs/overview.png b/httemplate/docs/overview.png Binary files differnew file mode 100644 index 000000000..bf2dbc26c --- /dev/null +++ b/httemplate/docs/overview.png diff --git a/httemplate/docs/passwd.html b/httemplate/docs/passwd.html new file mode 100755 index 000000000..fc1dde956 --- /dev/null +++ b/httemplate/docs/passwd.html @@ -0,0 +1,23 @@ +<head> + <title>fs_passwd</title> +</head> +<body> + <h1>fs_passwd</h1> +You may use fs_passwd/fs_passwd as a "passwd", "chfn" and "chsh" replacement on your shell machine(s) to cause password, gecos and shell changes to update your freeside machine. You can also use the fs_passwd/fs_passwd.html and fs_passwd/fs_passwd.cgi to run a public password change CGI on a public web server. This can pose a security risk if not configured correctly. <b>Do not use this feature unless you understand what you are doing!</b> +<br><br>Currently it is assumed that the the crypt(3) function in the C library is the same on the Freeside machine as on the target machine. +<ul> + <li>Create a freeside account on the shell or web machine(s). + <li>Setup SSH keys: + <ul> + <li>As the freeside user (on your freeside machine), generate an authentication key using <a href="http://www.tac.eu.org/cgi-bin/man-cgi?ssh-keygen+1">ssh-keygen</a>. Since this is for unattended operation, use a blank passphrase. + <li>Append the newly-created <code>identity.pub</code> file to <code>~freeside +/.ssh/authorized_keys</code> on the shell or web machine(s). + <li>Some new SSH v2 implementation accept v2 style keys only. Use the <code>-t</code> option to <a href="http://www.tac.eu.org/cgi-bin/man-cgi?ssh-keygen+1">ssh-keygen</a>, and append the created <code>id_dsa.pub</code> or <code>id_rsa.pub</code> to <code>~freeside/.ssh/authorized_keys2</code> on the remote machine(s). + </ul> + <li>Copy fs_passwd/fs_passwdd to /usr/local/sbin on the shell or web machine(s). (chown freeside, chmod 500) + <li>Create /usr/local/freeside on the shell or web machine(s). (chown freeside, chmod 700) + <li>Run an iteration of "fs_passwd/fs_passwd_server <i>user</i> shell.machine" as the freeside user for each shell or web machine (this is a daemon process). <i>user</i> refers to a freeside user added by <a href="man/bin/freeside-adduser.html">freeside-adduser</a>. + <li>Copy fs_passwd/fs_passwd to /usr/local/bin on the shell machine(s). (chown freeside, chmod 4755). You may link it to passwd, chfn and chsh as well. + <li>Copy fs_passwd/fs_passwd.cgi to the cgi-bin directory on your web machine(s). Use <a href="http://www.apache.org/docs/suexec.html">suEXEC</a> or <a href="http://www.perldoc.com/perl5.6.1/pod/perlsec.html">suidperl</a> to run fs_passwd.cgi as the freeside user. +</ul> +</body> diff --git a/httemplate/docs/schema.dia b/httemplate/docs/schema.dia Binary files differnew file mode 100644 index 000000000..e00f59ce1 --- /dev/null +++ b/httemplate/docs/schema.dia diff --git a/httemplate/docs/schema.html b/httemplate/docs/schema.html new file mode 100644 index 000000000..cd4914a6c --- /dev/null +++ b/httemplate/docs/schema.html @@ -0,0 +1,533 @@ + + <title>Schema reference</title> +</head> +<body> + <h1>Schema reference</h1> + Schema diagram (1.4.1): <a href="schema.png">as a giant .png</a> or <a href="schema.dia">dia source</a> (<a href="http://www.lysator.liu.se/~alla/dia/">dia homepage</a>). + <ul> + <li><a name="agent" href="man/FS/agent.html">agent</a> - Agents are resellers of your service. Agents may be limited to a subset of your full offerings (via their agent type). + <ul> + <li>agentnum - primary key + <li>agent - name of this agent + <li>typenum - <a href="#agent_type">agent type</a> + <li>prog - (unimplemented) + <li>freq - (unimplemented) + <li>disabled - Disabled flag, empty or 'Y' + <li>username - Username for the Agent interface + <li>_password - Password for the Agent interface + </ul> + <li><a name="agent_type" href="man/FS/agent_type.html">agent_type</a> - Agent types define groups of packages that you can then assign to particular agents. + <ul> + <li>typenum - primary key + <li>atype - name of this agent type + </ul> + <li><a name="cust_bill" href="man/FS/cust_bill.html">cust_bill</a> - Invoices. Declarations that a customer owes you money. The specific charges are itemized in <a href="#cust_bill_pkg">cust_bill_pkg</a>. + <ul> + <li>billpkgnum - primary_key + <li>invnum - primary key + <li>custnum - <a href="#cust_main">customer</a> + <li>_date + <li>charged - amount of this invoice + <li>printed - how many times this invoice has been printed automatically + <li>closed - books closed flag, empty or `Y' + </ul> + <li><a name="cust_bill_event" href="man/FS/cust_bill_event.html">cust_bill_event</a> - Invoice event history + <ul> + <li>eventnum - primary key + <li>invnum - <a href="#cust_bill">invoice</a> + <li>eventpart - <a href="#part_bill_event">event definition</a> + <li>_date + <li>status + <li>statustext + </ul> + <li><a name="part_bill_event" href="man/FS/part_bill_event.html">part_bill_event</a> - Invoice event definitions + <ul> + <li>eventpart - primary key + <li>payby - CARD, DCRD, CHEK, DCHK, LECB, BILL, or COMP + <li>event - event name + <li>eventcode - event action + <li>seconds - how long after the invoice date (<a href="#cust_bill">cust_bill</a>._date) events of this type are triggered + <li>weight - ordering for events with identical seconds + <li>plan - eventcode plan + <li>plandata - additional plan data + <li>disabled - Disabled flag, empty or `Y' + <li>taxclass - Texas tax class flag, empty or "none", "access", or "hosting" + </ul> + <li><a name="cust_bill_pkg" href="man/FS/cust_bill_pkg.html">cust_bill_pkg</a> - Invoice line items + <ul> + <li>invnum - (multiple) key + <li>pkgnum - <a href="#cust_pkg">package</a> or 0 for the special virtual sales tax package + <li>setup - setup fee + <li>recur - recurring fee + <li>sdate - starting date + <li>edate - ending date + <li>itemdesc - Line item description (currently used only when pkgnum is 0) + </ul> + <li><a name="cust_bill_pkg_detail" href="man/FS/cust_bill_pkg_detail.html">cust_bill_pkg_detail</a> - Invoice line items detail + <ul> + <li>detailnum - primary key + <li>pkgnum - + <li>invnum - + <li>detail - Detail description + </ul> + <li><a name="cust_credit" href="man/FS/cust_credit.html">cust_credit</a> - Credits. The equivalent of a negative <a href="#cust_bill">cust_bill</a> record. + <ul> + <li>crednum - primary key + <li>custnum - <a href="#cust_main">customer</a> + <li>amount - amount credited + <li>_date + <li>otaker - order taker + <li>reason + <li>closed - books closed flag, empty or `Y' + </ul> + <li><a name="cust_credit_bill" href="man/FS/cust_credit_bill.html">cust_credit_bill</a> - Credit invoice application. Links a credit to an invoice. + <ul> + <li>creditbillnum - primary key + <li>crednum - <a href="#cust_credit">credit</a> being applied + <li>invnum - <a href="#cust_bill">invoice</a> to which credit is applied + <li>amount - amount applied + <li>_date + </ul> + <li><a name="cust_pay_refund" href="man/FS/cust_pay_refund.html">cust_credit_bill</a> - Refund payment application. Links a refund to a payment. + <ul> + <li>payrefundnum - primary key + <li>paynum - <a href="#cust_pay">payment</a> + <li>refundnum - <a href="#cust_refund">refund</a> + <li>amount - amount applied + <li>_date + </ul> + <li><a name="cust_main" href="man/FS/cust_main.html">cust_main</a> - Customers + <ul> + <li>custnum - primary key + <li>agentnum - <a href="#agent">agent</a> + <li>refnum - <a href="#part_referral">referral</a> + <li>first - name + <li>last - name + <li>ss - social security number + <li>company + <li>address1 + <li>address2 + <li>city + <li>county + <li>state + <li>zip + <li>country + <li>daytime - phone + <li>night - phone + <li>fax - phone + <li><i>ship_first</i> + <li><i>ship_last</i> + <li><i>ship_company</i> + <li><i>ship_address1</i> + <li><i>ship_address2</i> + <li><i>ship_city</i> + <li><i>ship_county</i> + <li><i>ship_state</i> + <li><i>ship_zip</i> + <li><i>ship_country</i> + <li><i>ship_daytime</i> + <li><i>ship_night</i> + <li><i>ship_fax</i> + <li>payby - CARD, DCHK, CHEK, DCHK, LECB, BILL, or COMP + <li>payinfo - card number, P.O.#, or comp issuer + <li>paycvv - Card Verification Value, "CVV2" (also known as CVC2 or CID), the 3 or 4 digit number on the back (or front, for American Express) of the credit card + <li>paydate - expiration date + <li>payname - billing name (name on card) + <li>tax - tax exempt, Y or null + <li>otaker - order taker + <li>referral_custnum + <li>comments + </ul> + (columns in <i>italics</i> are optional) + <li><a name="cust_main_invoice" href="man/FS/cust_main_invoice.html">cust_main_invoice</a> - Invoice destinations for email invoices. Note that a customer can have many email destinations for their invoice (either literal or via svcnum), but only one postal destination. + <ul> + <li>destnum - primary key + <li>custnum - <a href="#cust_main">customer</a> + <li>dest - Invoice destination. Freeside supports three types of invoice delivery: send directly to a service defined in Freeside, send to an arbitrary email address, or print the invoice to a printer and have someone send it out via snail mail. Freeside determines which method to use based on the contents of the dest field. If the contents are numeric, a <a href="#svc_acct">svcnum</a> pointing to a valid service is expected in the field. If the contents are a string, a literal email address is expected to be in the field. If the special keyword `POST' is present, the snail mail method is used (which is the default if no cust_main_invoice records exist). Snail mail invoices get their address information from <A name="#cust_main">cust_main</A> and are printed with the printer defined in the configuration files. + </ul> + <li><a name="cust_main_county" href="man/FS/cust_main_county.html">cust_main_county</a> - Tax rates + <ul> + <li>taxnum - primary key + <li>state + <li>county + <li>country + <li>tax - % rate + <li>taxclass + <li>exempt_amount + <li>taxname - if defined, printed on invoices instead of "Tax" + <li>setuptax - if 'Y', this tax does not apply to setup fees + <li>recurtax - if 'Y', this tax does not apply to recurring fees + </ul> + <li><a name="cust_tax_exempt" href="man/FS/cust_tax_exempt.html">cust_tax_exempt</a> - Tax exemption record + <ul> + <li>exemptnum - primary key + <li>taxnum - <a href="#cust_main_county">tax rate</a> + <li>year + <li>month + <li>amount + </ul> + <li><a name="cust_pay" href="man/FS/cust_pay.html">cust_pay</a> - Payments. Money being transferred from a customer. + <ul> + <li>paynum - primary key + <li>custnum - <a href="#cust_main">customer</a> + <li>paid - amount + <li>_date + <li>payby - CARD, CHEK, LECB, BILL, or COMP + <li>payinfo - card number, P.O.#, or comp issuer + <li>paybatch - text field for tracking card processor batches + <li>closed - books closed flag, empty or `Y' + </ul> + <li><a name="cust_pay-void" href="man/FS/cust_pay_void.html">cust_pay_void</a> - Voided payments. + <ul> + <li>paynum - primary key + <li>custnum - <a href="#cust_main">customer</a> + <li>paid - amount + <li>_date + <li>payby - CARD, CHEK, LECB, BILL, or COMP + <li>payinfo - card number, P.O.#, or comp issuer + <li>paybatch - text field for tracking card processor batches + <li>closed - books closed flag, empty or `Y' + <li>void_date + <li>reason + <li>otaker - order taker + </ul> + <li><a name="cust_bill_pay" href="man/FS/cust_bill_pay.html">cust_bill_pay</a> - Applicaton of a payment to a specific invoice. + <ul> + <li>billpaynum + <li>invnum - <a href="#cust_bill">invoice</a> + <li>paynum - <a href="#cust_pay">payment</a> + <li>amount + <li>_date + </ul> + <li><a name="pay_batch" href="man/FS/pay_batch.html">pay_batch</a> - Pending batch + <ul> + <li>batchnum + <li>status + <li>download + <li>upload + </ul> + <li><a name="cust_pay_batch" href="man/FS/cust_pay_batch.html">cust_pay_batch</a> - Pending batch members + <ul> + <li>paybatchnum + <li>batchnum + <li>payby - CARD, CHEK, LECB, BILL, or COMP + <li>payinfo - account number + <li>exp - card expiration + <li>amount + <li>invnum - <a href="#cust_bill">invoice</a> + <li>custnum - <a href="#cust_main">customer</a> + <li>payname - name on card + <li>first - name + <li>last - name + <li>address1 + <li>address2 + <li>city + <li>state + <li>zip + <li>country + <li>status + </ul> + <li><a name="cust_pkg" href="man/FS/cust_pkg.html">cust_pkg</a> - Customer billing items + <ul> + <li>pkgnum - primary key + <li>custnum - <a href="#cust_main">customer</a> + <li>pkgpart - <a href="#part_pkg">Package definition</a> + <li>setup - date + <li>bill - next bill date + <li>last_bill - last bill date + <li>susp - (past) suspension date + <li>expire - (future) cancellation date + <li>cancel - (past) cancellation date + <li>otaker - order taker + <li>manual_flag - If this field is set to 1, disables the automatic unsuspensiond of this package when using the <a href="config.html#unsuspendauto">unsuspendauto</a> config file. + </ul> + <li><a name="cust_refund" href="man/FS/cust_refund.html">cust_refund</a> - Refunds. The transfer of money to a customer; equivalent to a negative <a href="#cust_pay">cust_pay</a> record. + <ul> + <li>refundnum - primary key + <li>custnum - <a href="#cust_main">customer</a> + <li>refund - amount + <li>_date + <li>payby - CARD, CHEK, LECB, BILL or COMP + <li>payinfo - card number, P.O.#, or comp issuer + <li>otaker - order taker + <li>closed - books closed flag, empty or `Y' + </ul> + <li><a name="cust_credit_refund" href="man/FS/cust_credit_refund.html">cust_credit_refund</a> - Applicaton of a refund to a specific credit. + <ul> + <li>creditrefundnum - primary key + <li>crednum - <a href="#cust_credit">credit</a> + <li>refundnum - <a href="#cust_refund">refund</a> + <li>amount + <li>_date + </ul> + <li><a name="cust_svc" href="man/FS/cust_svc.html">cust_svc</a> - Customer services + <ul> + <li>svcnum - primary key + <li>pkgnum - <a href="#cust_pkg">package</a> + <li>svcpart - <a href="#part_svc">Service definition</a> + </ul> + <li><a name="nas" href="man/FS/nas.html">nas</a> - Network Access Server (terminal server) + <ul> + <li>nasnum - primary key + <li>nas - NAS name + <li>nasip - NAS ip address + <li>nasfqdn - NAS fully-qualified domain name + <li>last - timestamp indicating the last instant the NAS was in a known state (used by the session monitoring). + </ul> + <li><a name="part_pkg" href="man/FS/part_pkg.html">part_pkg</a> - Package definitions + <ul> + <li>pkgpart - primary key + <li>pkg - package name + <li>comment - non-customer visable package comment + <li>promo_code - promotional code + <li><i>deprecated</i> setup - setup fee expression + <li>freq - recurring frequency (months) + <li><i>deprecated</i> recur - recurring fee expression + <li>setuptax - Setup fee tax exempt flag, empty or `Y' + <li>recurtax - Recurring fee tax exempt flag, empty or `Y' + <li>plan - price plan + <li><i>deprecated</i> plandata - additional price plan data + <li>disabled - Disabled flag, empty or `Y' + </ul> + <li><a name="part_pkg_option" href="man/FS/part_pkg_option.html">part_pkg_option</a> - Package definition options + <ul> + <li>optionnum - primary key + <li>pkgpart - <a href="#part_pkg">Package definition</a> + <li>optionname - option name + <li>optionvalue - option value + </ul> + <li><a name="reg_code" href="man/FS/reg_code.html">reg_code</A> - One-time registration codes + <ul> + <li>codenum - primary key + <li>code + <li>agentnum - <a href="#agent">Agent</a> + </ul> + <li><a name="reg_code_pkg" href="man/FS/reg_code_pkg.html">reg_code_pkg</A> - Registration code link to package definitions + <ul> + <li>codepkgnum - primary key + <li>codenum - <a href="#reg_code">Registration code</a> + <li>pkgpart - <a href="#part_pkg">Package definition</a> + </ul> + <li><a name="part_referral" href="man/FS/part_referral.html">part_referral</a> - Referral listing + <ul> + <li>refnum - primary key + <li>referral - referral + </ul> + <li><a name="part_svc" href="man/FS/part_svc.html">part_svc</a> - Service definitions + <ul> + <li>svcpart - primary key + <li>svc - name of this service + <li>svcdb - table used for this service: svc_acct, svc_forward, svc_domain, svc_charge or svc_wo + <li>disabled - Disabled flag, empty or `Y' +<!-- <li><i>table</i>__<i>field</i> - Default or fixed value for <i>field</i> in <i>table</i> + <li><i>table</i>__<i>field</i>_flag - null, D or F +--> + </ul> + <li><a name="part_svc_column" href="man/FS/part_svc_column.html">part_svc_column</a> + <ul> + <li>columnnum - primary key + <li>svcpart - <a href="#part_svc">Service definition</a> + <li>columnname - column name in part_svc.svcdb table + <li>columnvalue - default or fixed value for the column + <li>columnflag - null, D or F + </ul> + <li><a name="pkg_svc" href="man/FS/pkg_svc.html">pkg_svc</a> + <ul> + <li>pkgsvcnum - primary key + <li>pkgpart - <a href="#part_pkg">Package definition</a> + <li>svcpart - <a href="#part_svc">Service definition</a> + <li>quantity - quantity of this service that this package includes + <li>primary_svc - blank or Y: primary service + </ul> + <li><a name="export_svc" href="man/FS/export_svc.html">export_svc</a> + <ul> + <li>exportsvcnum - primary key + <li>svcpart - <a href="#part_svc">Service definition</a> + <li>exportnum - <a href="#exportnum">Export</a> + </ul> + <li><a name="part_export" href="man/FS/part_export.html">part_export</a> - Export to external provisioning + <ul> + <li>exportnum - primary key + <li>machine - Machine name + <li>exporttype - Export type + <li>nodomain - blank or Y: usernames are exported to this service with no domain + </ul> + <li><a name="part_export_option" href="man/FS/part_export_option.html">part_export_option</a> - provisioning options + <ul> + <li>optionnum - primary key + <li>exportnum - <a href="#part_export">Export</a> + <li>optionname - option name + <li>optionvalue - option value + </ul> + <li><a name="port" href="man/FS/port.html">port</a> - individual port on a <a href="#nas">nas</a> + <ul> + <li>portnum - primary key + <li>ip - IP address of this port + <li>nasport - port number on the NAS + <li>nasnum - <a href="#nas">NAS</a> + </ul> + <li><a name="prepay_credit" href="man/FS/prepay_credit.html">prepay_credit</a> - prepaid cards + <ul> + <li>prepaynum - primary key + <li>identifier - text or numeric string of prepaid card + <li>amount - amount of prepayment + <li>seconds - prepaid time instead of (or in addition to) monetary value + <li>agentnum - optional agent assignment for prepaid cards + </ul> + <li><a name="session" href="man/FS/session.html">session</a> + <ul> + <li>sessionnum - primary key + <li>portnum - <a href="#port">Port</a> + <li>svcnum - <a href="#svc_acct">Account</a> + <li>login - timestamp indicating the beginning of this user session. + <li>logout - timestamp indicating the end of this user session. May be null, which indicates a currently open session. + </ul> + + <li><a name="svc_acct" href="man/FS/svc_acct.html">svc_acct</a> - Accounts + <ul> + <li>svcnum - <a href="#cust_svc">primary key</a> + <li>username + <li>_password + <li>sec_phrase - security phrase + <li>popnum - <a href="#svc_acct_pop">Point of Presence</a> + <li>uid + <li>gid + <li>finger - GECOS + <li>dir + <li>shell + <li>quota - (unimplementd) + <li>slipip - IP address + <li>seconds + <li>domsvc + <li>radius_<i>Radius_Reply_Attribute</i> - Radius-Reply-Attribute + <li>rc_<i>Radius_Check_Attribute</i> - Radius-Check-Attribute + </ul> + <li><a name="svc_acct_pop" href="man/FS/svc_acct_pop.html">svc_acct_pop</a> - Points of Presence + <ul> + <li>popnum - primary key + <li>city + <li>state + <li>ac - area code + <li>exch - exchange + <li>loc - rest of number + </ul> + <li><a name="part_pop_local" href="man/FS/part_pop_local.html">part_pop_local</a> - Local calling areas + <ul> + <li>localnum - primary key + <li>popnum - primary key + <li>city + <li>state + <li>npa - area code + <li>nxx - exchange + </ul> + <li><a name="svc_domain" href="man/FS/svc_domain.html">svc_domain</a> - Domains + <ul> + <li>svcnum - <a href="#cust_svc">primary key</a> + <li>domain + </ul> + <li><a name="svc_forward" href="man/FS/svc_forward.html">svc_forward</a> - Mail forwarding aliases + <ul> + <li>svcnum - <a href="#cust_svc">primary key</a> + <li>srcsvc - <a href="#svc_acct">svcnum of the source of this forward</a> + <li>src - literal source (username or full email address) + <li>dstsvc - <a href="#svc_acct">svcnum of the destination of this forward</a> + <li>dst - literal destination (username or full email address) + </ul> + <li><a name="domain_record" href="man/FS/domain_record.html">domain_record</a> - Domain zone detail + <ul> + <li>recnum - primary key + <li>svcnum - <a href="#svc_domain">Domain</a> (by svcnum) + <li>reczone - zone for this line + <li>recaf - address family, usually <b>IN</b> + <li>rectype - type for this record (<b>A</b>, <b>MX</b>, etc.) + <li>recdata - data for this record + </ul> + <li><a name="svc_www" href="man/FS/svc_www.html">svc_www</a> + <ul> + <li>svcnum - <a href="#cust-svc">primary key</a> + <li>recnum - <a href="#domain_record">host</a> + <li>usersvc - <a href="#svc_acct">account</a> + </ul> + <li><a name="type_pkgs" href="man/FS/type_pkgs.html">type_pkgs</a> + <ul> + <li>typepkgnum - primary key + <li>typenum - <a href="#agent_type">agent type</a> + <li>pkgpart - <a href="#part_pkg">Package definition</a> + </ul> + <li><a name="queue" href="man/FS/queue.html">queue</a> - job queue + <ul> + <li>jobnum - primary key + <li>job + <li>_date + <li>status + <li>statustext + <li>svcnum + </ul> + <li><a name="queue_arg" href="man/FS/queue_arg.html">queue_arg</a> - job arguments + <ul> + <li>argnum - primary key + <li>jobnum - <a href="#queue">job</a> + <li>arg - argument + </ul> + <li><a name="queue_depend" href="man/FS/queue_depend.html">queue_depend</a> - job dependancies + <ul> + <li>dependnum - primary key + <li>jobnum - source jobnum + <li>depend_jobnum - dependancy jobnum + </ul> + <li><a name="radius_usergroup" href="man/FS/radius_usergroup.html">radius_usergroup</a> - Link users to RADIUS groups. + <ul> + <li>usergroupnum - primary key + <li>svcnum - <a href="#svc_acct">account</a> + <li>groupname + </ul> + <li><a name="rate" href="man/FS/rate.html">rate</a> - Call rate plans + <ul> + <li>ratenum - primary key + <li>ratename + </ul> + <li><a name="rate_detail" href="man/FS/rate_detail.html">rate_detail</a> - Call rate detail + <ul> + <li>ratedetailnum - primary key + <li>ratenum - <a href="#rate">rate plan</a> + <li>orig_regionnum - call origination <a href="#rate_region">region</a> + <li>dest_regionnum - call destination <a href="#rate_region">region</a> + <li>min_included - included minutes + <li>min_charge - charge per minute + <li>sec_granularity - granularity in seconds, i.e. 6 or 60 + </ul> + <li><a name="rate_region" href="man/FS/rate_region.html">rate_region</a> - Call rate region + <ul> + <li>regionnum - primary key + <li>regionname + </ul> + <li><a name="rate_prefix" href="man/FS/rate_prefix.html">rate_prefix</a> - Call rate prefix + <ul> + <li>prefixnum - primary key + <li>regionnum - <a href="#rate_region">rate region</a> + <li>countrycode + <li>npa + <li>nxx + </ul> + <li><a name="msgcat" href="man/FS/msgcat.html">msgcat</a> - i18n message catalog + <ul> + <li>msgnum - primary key + <li>msgcode - message code + <li>locale - locale + <li>msg - Message text + </ul> + <li><a name="clientapi_session" href="man/FS/clientapi_session.html">clientapi_session</a> - ClientAPI session store + <ul> + <li>sessionnum - primary key + <li>sessionid - session ID + <li>namespace - session namespace + </ul> + <li><a name="clientapi_session_field" href="man/FS/clientapi_session_field.html">clientapi_session_field</a> - Client API session store data + <ul> + <li>fieldnum - primary key + <li>sessionnum - <a href="#session">session</a> + <li>fieldname + <li>fieldvalue + </ul> + </ul> +</body> diff --git a/httemplate/docs/schema.png b/httemplate/docs/schema.png Binary files differnew file mode 100644 index 000000000..d0392e76f --- /dev/null +++ b/httemplate/docs/schema.png diff --git a/httemplate/docs/session.html b/httemplate/docs/session.html new file mode 100644 index 000000000..72e16424e --- /dev/null +++ b/httemplate/docs/session.html @@ -0,0 +1,59 @@ +<head> + <title>Session monitor</title> +</head> +<body> +<h1>Session monitor</h1> +<h2>Installation</h2> +For security reasons, the client portion of the session montior may run on one +or more external public machine(s). On these machines, install: +<ul> + <li><a href="http://www.perl.com/CPAN/doc/relinfo/INSTALL.html">Perl</a> (at l +east 5.004_05 for the 5.004 series or 5.005_03 for the 5.005 series. Don't enable experimental features like threads or the PerlIO abstraction layer.) + <li><a href="man/FS/SessionClient.html">FS::SessionClient</a> (copy the fs_session/FS-SessionClient directory to the external machine, then: perl Makefile.PL; make; make install) +</ul> +Then: +<ul> + <li>Add the user `freeside' to the the external machine. + <li>Create the /usr/local/freeside directory on the external machine (owned by the freeside user). + <li>touch /usr/local/freeside/fs_sessiond_socket; chown freeside /usr/local/freeside/fs_sessiond_socket; chmod 600 /usr/local/freeside/fs_sessiond_socket + <li>Append the identity.pub from the freeside user on your freeside machine to the authorized_keys file of the newly created freeside user on the external machine(s). + <li>Run <pre>fs_session_server <i>user</i> <i>machine</i></pre> on the Freeside machine. + <ul> + <li><i>user</i> is a user from the mapsecrets file. + <li><i>machine</i> is the name of the external machine. + </ul> +</ul> +<h2>Usage</h2> +<ul> + <li>Web + <ul> + <li>Copy FS-SessionClient/cgi/login.cgi and logout.cgi to your web + server's document space. + <li>Use <a href="http://www.apache.org/docs/suexec.html">suEXEC</a> or <a href="http://www.perl.com/CPAN-local/doc/manual/html/pod/perlsec.html#Security_Bugs">setuid</a> (see <a href="install.html">install.html</a> for details) to run login.cgi and logout.cgi as the freeside user. + </ul> + <li>Command-line + <br><pre>freeside-login username ( portnum | ip | nasnum nasport ) +freeside-logout username ( portnum | ip | nasnum nasport )</pre> + <ul> + <li><i>username</i> is a customer username from the svc_acct table + <li><i>portnum</i>, <i>ip</i> or <i>nasport</i> and <i>nasnum</i> uniquely identify a port in the <a href="schema.html#port">port</a> database table. + </ul> + <li>RADIUS - One of: + <ul> + <li>Run the <b>freeside-sqlradius-radacctd</b> daemon to import radacct + records from all configured sqlradius exports: + <tt>freeside-sqlradius-radacctd username</tt> + <li>Configure your RADIUS server's login and logout callbacks to use the command-line <tt>freeside-login</tt> and <tt>freeside-logout</tt> utilites. + <li> <i>(incomplete)</i>Use the <b>fs_radlog/fs_radlogd</b> tool to + import records from a text radacct file. + </ul> +</ul> +<h2>Callbacks</h2> +<ul> + <li>Sesstion start - The command(s) specified in the <a href="config.html#session-start">session-start</a> configuration file are executed on the Freeside machine. The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on. + <li>Session end - The command(s) specified in the <a href="config.html#session-stop">session-stop</a> configuration file are executed on the Freeside machine. The contents of the file are treated as a double-quoted perl string, with the following variables available: <code>$ip</code>, <code>$nasip</code> and <code>$nasfqdn</code>, which are the IP address of the starting session, and the IP address and fully-qualified domain name of the NAS this session is on. +</ul> +<h2>Dropping expired users</h2> +Run <pre>bin/freeside-session-kill username</pre> periodically from cron. +</body> +</html> diff --git a/httemplate/docs/signup.html b/httemplate/docs/signup.html new file mode 100644 index 000000000..97d7aa794 --- /dev/null +++ b/httemplate/docs/signup.html @@ -0,0 +1,54 @@ +<head> + <title>Signup server</title> +</head> +<body> + <h1>Signup server</h1> +For security reasons, the signup server should run on an external public +webserver. On this machine, install: +<ul> + <li>A web server, such as <a href="http://www.apache-ssl.org">Apache-SSL</a> or <a href="http://www.apache.org">Apache</a> + <li><a href="ftp://ftp.cs.hut.fi/pub/ssh/">SSH</a> + <li><a href="http://www.perl.com/CPAN/doc/relinfo/INSTALL.html">Perl</a> (at least 5.004_05 for the 5.004 series or 5.005_03 for the 5.005 series. Don't enable experimental features like threads or the PerlIO abstraction layer.) + <li><a href="http://search.cpan.org/search?dist=Text-Template">Text::Template</a> + <li><a href="http://search.cpan.org/search?dist=Storable">Storable</a> + <li><a href="http://search.cpan.org/search?dist=Business-CreditCard">Business-CreditCard</a> + <li><a href="http://search.cpan.org/search?dist=HTTP-BrowserDetect">HTTP::BrowserDetect</a> + + <li><a href="man/FS/SignupClient.html">FS::SignupClient</a> (copy the fs_signup/FS-SignupClient directory to the external machine, then: perl Makefile.PL; make; make install) +</ul> +Then: +<ul> + <li>Add the user `freeside' to the the external machine. + <li>Copy or symlink fs_signup/FS-SignupClient/cgi/signup.cgi into the web server's document space. + <li>When linking to signup.cgi, you can include a referring custnum in the URL as follows: <code>http://public.web.server/path/signup.cgi?ref=1542</code> + <li>Enable CGI execution for files with the `.cgi' extension. (with <a href="http://www.apache.org/docs/mod/mod_mime.html#addhandler">Apache</a>) + <li>Create the /usr/local/freeside directory on the external machine (owned by the freeside user). + <li>touch /usr/local/freeside/fs_signupd_socket; chown freeside /usr/local/freeside/fs_signupd_socket; chmod 600 /usr/local/freeside/fs_signupd_socket + <li>Use <a href="http://www.apache.org/docs/suexec.html">suEXEC</a> or <a href="http://www.perl.com/CPAN-local/doc/manual/html/pod/perlsec.html#Security_Bugs">setuid</a> (see <a href="install.html">install.html</a> for details) to run signup.cgi as the freeside user. + <li>Append the identity.pub from the freeside user on your freeside machine to the authorized_keys file of the newly created freeside user on the external machine(s). + <li>Run <pre>fs_signup_server <i>user</i> <i>machine</i> <i>agentnum</i> <i>refnum</i></pre> on the Freeside machine. + <ul> + <li><i>user</i> is a user from the mapsecrets file. + <li><i>machine</i> is the name of the external machine. + <li><i>agentnum</i> and <i>refnum</i> are the <a href="schema.html#agent">agent</a> and <a href="schema.html#part_referral">referral</a>, respectively, to use for customers who sign up via this signup server. + </ul> +</ul> +Optional: +<ul> + <li>If you create a <b>/usr/local/freeside/ieak.template</b> file on the external machine, it will be sent to IE users with MIME type <i>application/x-Internet-signup</i>. This file will be processed with <a href="http://search.cpan.org/doc/MJD/Text-Template-1.23/Template.pm">Text::Template</a> with the variables listed below available. + (an example file is included as <b>fs_signup/ieak.template</b>) See the section on <a href="http://www.microsoft.com/windows/ieak/techinfo/deploy/60/en/INS.HTM">internet settings files</a> in the <a href="http://www.microsoft.com/windows/ieak/techinfo/deploy/60/en/toc.asp">IEAK documentation</a> for more information. + <li>If you create a <b>/usr/local/freeside/success.html</b> file on the external machine, it will be used as the success HTML page. Although template substiutions are available, a regular HTML file will work fine here, unlike signup.html. An example file is included as <b>fs_signup/FS-SignupClient/cgi/success.html</b> + <li>Variable substitutions available in <b>ieak.template</b>, <b>cck.template</b> and <b>success.html</b>: + <ul> + <li>$ac - area code of selected POP + <li>$exch - exchange of selected POP + <li>$loc - local part of selected POP + <li>$username + <li>$password + <li>$email_name - first and last name + <li>$pkg - package name + </ul> + <li>If you create a <b>/usr/local/freeside/signup.html</b> file on the external machine, it will be used as a template for the form HTML. This requires the template to be constructed appropriately; probably best to start with the example file included as <b>fs_signup/FS-SignupClient/cgi/signup.html</b>. + <li>If there are any entries in the <i>prepay_credit</i> table, a user can enter a string matching the <b>identifier</i> column to receive the credit specified in the <b>amount</b> column, and/or the time specified in the <b>seconds</b> column (for use with the <a href="session.html">session monitor</a>), after which that <b>identifier</b> is no longer valid. This can be used to implement pre-paid "calling card" type signups. The <i>bin/generate-prepay</i> script can be used to populate the <i>prepay_credit</i> table. +</ul> +</body> diff --git a/httemplate/docs/ssh.html b/httemplate/docs/ssh.html new file mode 100755 index 000000000..d2c501e35 --- /dev/null +++ b/httemplate/docs/ssh.html @@ -0,0 +1,16 @@ +<head> + <title>Unattended SSH</title> +</head> +<body> + <h1>Unattended SSH</h1> + <br><a name=ssh>Unattended remote login</a> - Freeside can login to remote machines unattended using SSH. This can pose a security risk if not configured correctly, and will allow an intruder who breaks into your freeside machine full access to your remote machines. <b>Do not use this feature unless you understand what you are doing!</b> + <ul> + <li>As the freeside user (on your freeside machine), generate an authentication key using <a href="http://www.tac.eu.org/cgi-bin/man-cgi?ssh-keygen+1">ssh-keygen</a>. Since this is for unattended operation, use a blank passphrase. + <li>Append the newly-created <code>identity.pub</code> file to <code>~root/.ssh/authorized_keys</code> (or the appopriate <code>~username/.ssh/authorized_keys</code>) on the remote machine(s). + <li>Some new SSH v2 implementation accept v2 style keys only. Use the <code>-t</code> option to <a href="http://www.tac.eu.org/cgi-bin/man-cgi?ssh-keygen+1">ssh-keygen</a>, and append the created <code>id_dsa.pub</code> or <code>id_rsa.pub</code> to <code>~root/.ssh/authorized_keys2</code> (or the appopriate <code>~username/.ssh/authorized_keys</code>) on the remote machine(s). + <li>You may need to set <code>PermitRootLogin without-password</code> (meaning with keys only) in your <code>sshd_config</code> file on the remote machine(s). + <li>You may want to set <code>ForwardX11 = no</code> in <code>~root/.ssh/config</code> to prevent spurious errors if your distribution turns on X11 forwarding by default. + </ul> + +</body> + |
