| | 1 | = Web site overview = |
| | 2 | |
| | 3 | |
| | 4 | == Customizing the default web site == |
| | 5 | When you create a BOINC project using [http://boinc.berkeley.edu/make_project.php make_project], a web site is created for you. This consists of a front page (html/user/index.php), which links to pages where users can log in, edit preferences, create profiles, and so on. |
| | 6 | |
| | 7 | Before your project goes public, you'll want to change this web site by adding content specific to your project, and by giving the web site a graphical identity specific to your project. Make sure you do a good job; your web site has a large impact on your project's ability to [http://boinc.berkeley.edu/recruit.php recruit and retain participants]. |
| | 8 | |
| | 9 | Some of this customization can be done by editing the main page (index.php) and the stylesheet (white.css). Other aspects are changed using a configuration file, described below. |
| | 10 | |
| | 11 | |
| | 12 | == Web configuration file == |
| | 13 | The file 'html/project/project.inc' serves as a configuration file for your web site. It exists in a separate directory (html/project) so that you can put this directory under CVS and put all project-specific web files there (create symbolic links from html/inc and html/user). |
| | 14 | |
| | 15 | project.inc is generated by [http://boinc.berkeley.edu/make_project.php make_project] with default values. It includes constants: |
| | 16 | |
| | 17 | |
| | 18 | |
| | 19 | '''PROJECT''':: |
| | 20 | The name of your project |
| | 21 | '''MASTER_URL''':: |
| | 22 | Your project's master URL |
| | 23 | '''URL_BASE''':: |
| | 24 | Base URL for web pages (usually same as master URL) |
| | 25 | '''STYLESHEET''':: |
| | 26 | Name of stylesheet file |
| | 27 | '''COPYRIGHT_HOLDER''':: |
| | 28 | Name of copyright holder |
| | 29 | '''SYS_ADMIN_EMAIL''':: |
| | 30 | Users are directed here if they have complaints about message-board moderation. Also, messages about user-of-the-day running low are sent here. |
| | 31 | '''FORUM_MODERATION_EMAIL_USER_ID''':: |
| | 32 | Moderation-related emails (such as user complaints) are sent here. |
| | 33 | '''INVITE_CODES''':: |
| | 34 | regular expression used for [http://boinc.berkeley.edu/account_control.php controlling account creation]. |
| | 35 | '''EMAIL_FROM''':: |
| | 36 | 'from' address for emails |
| | 37 | '''EMAIL_FROM_NAME''':: |
| | 38 | 'from' name for emails |
| | 39 | and functions: |
| | 40 | |
| | 41 | |
| | 42 | |
| | 43 | '''project_banner()''':: |
| | 44 | prints page header |
| | 45 | '''project_banner()''':: |
| | 46 | prints page footer |
| | 47 | '''show_profile_heading1(), show_profile_heading2()''':: |
| | 48 | text on user profile page |
| | 49 | '''show_profile_question1(), show_profile_question2()''':: |
| | 50 | text on user profile page |
| | 51 | '''project_workunit()''':: |
| | 52 | prints project-specific text on workunit page |
| | 53 | '''project_user_summary()''':: |
| | 54 | prints project-specific text on user page |
| | 55 | '''project_user_page_private()''':: |
| | 56 | prints project-specific text on private user page |
| | 57 | and variables: |
| | 58 | |
| | 59 | |
| | 60 | |
| | 61 | '''USE_PHPMAILER''':: |
| | 62 | Set to true if you use [http://phpmailer.sourceforge.net/ PHPMailer]. In this case you must download PHPMailer and put it (i.e. the directory 'phpmailer') in your html/inc directory. |
| | 63 | '''PHPMAILER_HOST''':: |
| | 64 | The Host argument to PHPMailer; typically a semicolon-separated list of SMTP servers. |
| | 65 | '''PHPMAIL_MAILER''':: |
| | 66 | The Mailer argument to PHPMailer; typically 'sendmail', 'mail', or 'smtp'. |
| | 67 | |
| | 68 | |
