be53c09505f6c717942a35e79d4bf53cb534bd2b
[freeside.git] / httemplate / docs / admin.html
1 <head>
2   <title>Administration</title>
3 </head>
4 <body>
5   <h1>Administration</h1>
6 </body>
7 <ul>
8   <li>Open up the root of the Freeside document tree in your web
9   browser.  For example, if you created the Freeside document tree in   
10   /home/httpd/html/freeside, and your web browser's DocumentRoot is
11   /home/httpd/html, open http://your_host/freeside/. Replace
12   "your_host" with the name or network address of your web server.
13
14   <li>Once in the Freeside web interface, you must first create a
15   service.  An example of a service would be a dial-up account or a
16   hosted virtual domain.
17
18   <li>After you create your first service or services, you must then
19   create a package of that service or services which you will sell to
20   your customer.  To allow flexibility in changing your service
21   offerings, Freeside requires that you bundle your services into a
22   package before customers may purchase them.  For instance, you could
23   create a leased line package which would consist of a one-time
24   charge for the customer premise equipment, the monthly service fee
25   for the leased line, a backup dial-up account, and a support
26   contract.  You could also create a leased line package which omits
27   the support contract simply by adding a new package that does not
28   include the support contract.
29   
30   <li>After you create your first package, then you must define who is
31   able to sell that package by creating an agent type.  An example of
32   an agent type would be an internal sales representitive which sells
33   regular and promotional packages, as opposed to an external sales
34   representitive which would only sell regular packages of services.
35
36   <li>After creating a new agent type, you must create an agent, and
37   assign the the agent type you just created to it.
38
39   <li>If the service you created was of type svc_acct, you may have to
40   create a POP from the main menu before you can create your first new
41   customer.
42
43   <li>If you are using Freeside to keep track of sales taxes, you must
44   define tax information for your locale by clicking on the "View/Edit  
45   locales and tax rates" link on the Freeside main menu.
46
47   <li>Finally, set up at least one referral by clicking on the
48   "View/Edit referrals" link in the Freeside main menu.  Referrals
49   will help you keep track of how effective your advertising is, by
50   helping you keep track of where customers heard of your service
51   offerings.  You must create at least one referral.  If you do not wish to
52   use the referral functionality, simply create a single referral only.
53   
54   <li>You should now be ready to sign up your first customer by
55   clicking on the "New Customer" link at the top of the Freeside main
56   menu.
57 </ul>
58 </body>
59 </html>