summaryrefslogtreecommitdiff
path: root/htdocs/docs
diff options
context:
space:
mode:
Diffstat (limited to 'htdocs/docs')
-rw-r--r--htdocs/docs/admin.html53
-rw-r--r--htdocs/docs/config.html1
-rw-r--r--htdocs/docs/index.html4
-rw-r--r--htdocs/docs/install.html1
4 files changed, 57 insertions, 2 deletions
diff --git a/htdocs/docs/admin.html b/htdocs/docs/admin.html
index 8adddbe92..b6665e05e 100644
--- a/htdocs/docs/admin.html
+++ b/htdocs/docs/admin.html
@@ -4,3 +4,56 @@
<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 http://your_host/freeside/. Replace
+ "your_host" with the name or network address of your web server.
+
+ <li>Once in the Freeside web interface, you must first create a
+ service. An example of a service would be a dial-up account or a
+ hosted virtual domain.
+
+ <li>After you create your first service or services, you must then
+ create a package of that service or services which you will sell to
+ your customer. To allow flexibility in changing your service
+ offerings, Freeside requires that you bundle your services into a
+ package before customers may purchase them. For instance, you could
+ create a leased line package which would consist of a one-time
+ charge for the customer premise equipment, the monthly service fee
+ for the leased line, a backup dial-up account, and a support
+ contract. You could also create a leased line package which omits
+ the support contract simply by adding a new package that does not
+ include the support contract.
+
+ <li>After you create your first package, then you must define who is
+ able to sell that package by creating an agent type. An example of
+ an agent type would be an internal sales representitive which sells
+ regular and promotional packages, as opposed to an external sales
+ representitive which would only sell regular packages of services.
+
+ <li>After creating a new agent type, you must create an agent, and
+ assign the the agent type you just created to it.
+
+ <li>If the service you created was of type svc_acct, you may have to
+ create a POP from the main menu before you can create your first new
+ customer.
+
+ <li>If you are using Freeside to keep track of sales taxes, you must
+ define tax information for your locale by clicking on the "View/Edit
+ locales and tax rates" link on the Freeside main menu.
+
+ <li>Finally, you may optionally set up a referral by clicking on the
+ "View/Edit referrals" link in the Freeside main menu. Referrals
+ will help you keep track of how effective your advertising is, by
+ helping you keep track of where customers heard of your service
+ offerings. You must create at least one referral. If you do not wish to
+ use the referral functionality, simply create a single referral only.
+
+ <li>You should now be ready to sign up your first customer by
+ clicking on the "New Customer" link at the top of the Freeside main
+ menu.
+</ul>
+</body>
+</html>
diff --git a/htdocs/docs/config.html b/htdocs/docs/config.html
index e42cfd8e1..db218d642 100644
--- a/htdocs/docs/config.html
+++ b/htdocs/docs/config.html
@@ -25,6 +25,7 @@ All further configuration files and directories are located in
<li><a name="apacheroot">apacheroot</a> - The directory containing Apache virtual hosts
<li><a name="apachemachine">apachemachine</a> - A machine with the apacheroot directory and user home directories. The existance of this file enables setup of virtual host directories, and, in conjunction with the `home' configuration file, symlinks into user home directories.
<li><a name="apachemachines">apachemachines</a> - Your Apache machines, one per line. This enables export of `/etc/apache/vhosts.conf', which can be included in your Apache configuration via the <a href="http://www.apache.org/docs/mod/core.html#include">Include</a> directive.
+ <li><a name="autocapnames">autocapnames</a> - The presence of this file will cause Freeside to use Javascript in /htdocs/edit/cust_main.cgi to automatically capitalize the first and last names of customers.
<li><a name="bindprimary">bindprimary</a> - Your BIND primary nameserver. This enables export of /var/named/named.conf and zone files into /var/named
<li><a name="bindsecondaries">bindsecondaries</a> - Your BIND secondary nameservers, one per line. This enables export of /var/named/named.conf
<li><a name="bsdshellmachines">bsdshellmachines</a> - Your BSD flavored shell (and mail) machines, one per line. This enables export of `/etc/passwd' and `/etc/master.passwd'.
diff --git a/htdocs/docs/index.html b/htdocs/docs/index.html
index f5c43d02c..fa0459bca 100644
--- a/htdocs/docs/index.html
+++ b/htdocs/docs/index.html
@@ -12,10 +12,10 @@
<li><a href="upgrade5.html">Upgrading from 1.2.2 to 1.2.3</a>
<li><a href="upgrade6.html">Upgrading from 1.2.3 to 1.2.4</a>
<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="legacy.html">Importing legacy data</a>
<li><a href="export.html">File exporting and remote setup</a>
<li><a href="passwd.html">fs_passwd</a>
diff --git a/htdocs/docs/install.html b/htdocs/docs/install.html
index 300104b2d..21b575139 100644
--- a/htdocs/docs/install.html
+++ b/htdocs/docs/install.html
@@ -77,5 +77,6 @@ chmod 755 browse/*.cgi edit/*.cgi edit/process/*.cgi misc/*.cgi misc/process/*.c
<li>Create the `/usr/local/etc/freeside/counters.<i>datasrc</i>', and
`/usr/local/etc/freeside/export.<i>datasrc</i>' directories for each <i>datasrc</i> (owned by the freeside user).
<li>As the freeside user, run bin/fs-setup to create the database tables.
+ <li>Now proceed to the initial <a href="admin.html">administration</a> of your installation.
</ul>
</body>