TWiki dir: | >What it is: | >Where to copy: | >Example: | >
---|---|---|---|
twiki |
> start-up pages | >root TWiki dir | >/home/smith/twiki/ |
>
twiki/bin |
> CGI bin | >CGI-enabled dir | >/home/smith/twiki/bin |
>
twiki/lib |
> library files | > same level as twiki/bin |
> /home/smith/twiki/lib |
>
twiki/pub |
> public files | >htdoc enabled dir | >/home/smith/twiki/pub |
>
twiki/data |
> topic data | >dir secure from public access | >/home/smith/twiki/data |
>
twiki/templates |
> web templates | >dir secure from public access | >/home/smith/twiki/templates |
>
**Net::SMTP**
is installed, TWiki will connect to this SMTP server (e.g. `mail.yourdomain.com`) to send email for user registration and [[WebChangesAlerts]]. If you do have a sendmail-type program, leave `SMTPMAILHOST` unset so that the external sendmail program is used instead (defined by **$mailProgram**
in **TWiki.cfg**
).
- `SMTPSENDERHOST` is optional, and set to the domain name sending the email (e.g. `twiki.yourdomain.com`). For use where the SMTP server requires that you identify the TWiki server sending mail. If not set, **Net::SMTP**
will guess it for you.
- You may want to set up other [[TWikiPreferences]] later on.
- To enable the [[WebChangesAlerts]] (email notifications) you need to read about cron in the topic [[TWikiSiteTools]].
### Step 6: Finish Up from Your Browser
- Point your Web browser at `http://yourdomain.com/twiki/bin/view` and start TWiki-ing away!
- %T% Or, point to `http://yourdomain.com/twiki/` to get the pre-TWiki `index.html` page, with a link to the `view` script. Customize this page if you want a public intro screen with a login link, instead of immediately calling up the .htaccess login dialog by going directly to `view`.
- Edit the [[WebPreferences]] topic in each web, if necessary: set individual `WEBCOPYRIGHT` messages, and other preferences.
- Enable email notification of topic changes - [[TWikiSiteTools]] has more.
- Edit the [[WebNotify]] topic in all webs and add the users you want to notify.
- Add the TWiki:Main/PoweredByTWikiLogo to your [[Main.WebHome|Main/WebHome]] topic.
- You can add new `%VARIABLES%`. Define site-level variables in the [[TWikiPreferences]] topic. See also: [[TWikiVariables]].
That's it for the standard installation of TWiki. Read on for server-level customization options.
## Additional Server-Level Options
With your new TWiki installation up and running, you can manage most aspects of your site from the browser interface. Only a few functions require access to the server file system, via Telnet or FTP. You can make these server-level changes during installation, and at any time afterwards.
### Enabling Authentication of Users
- If TWiki is installed on a non-authenticated server - not using SSL - and you'd like to authenticate users:
1. **Rename** file `.htaccess.txt` in the `twiki/bin` directory to `.htaccess` and change it to your needs. For details, consult the HTTP server documentation (for Apache server: [[1]](http://www.apache.org/docs/mod/directives.html), [[2]](http://systems.mcs.kent.edu/info/web_help/htaccess/)). In particular, the following red part needs to be configured correctly: Redirect /urlpathto/twiki/index.html http://yourdomain.com/urlpathto/twiki/bin/view
AuthUserFile /filepathto/twiki/data/.htpasswd
ErrorDocument 401 /urlpathto/twiki/bin/oops/TWiki/TWikiRegistration?template=oopsauth
- %X% **NOTE:** If you had to add a `.cgi` or `.pl` file extension to the `bin` scripts, make sure to do the same for `edit`, `view`, `preview`, and all the other script names in `.htaccess`.
- %H% The browser should ask for login name and password when you click on the Edit link. In case `.htaccess` does not have the desired effect, you need to enable it: Add "AllowOverride All" to the Directory [[3]](http://httpd.apache.org/docs/mod/core.html#directory) section of `access.conf` for your `twiki/bin` directory.
- **This applies only if you have root access:** on hosted accounts, you shouldn't have this problem - otherwise, email tech support.
- %X% **NOTE:** In the TWiki distribution package, the `twiki/data/.htpasswd.txt` file contains several TWiki core team user accounts and a guest user account. You probably want to remove those accounts by deleting the entries in `.htpasswd`. Do not remove the guest user if you want to allow guest logins.
2. TWiki now supports several Password file format/encoding methods for Apache. Once you know what method is used by your Appache server, you can configure TWiki to create compatible .htpasswd entries by editing the `$htpasswdFormatFamily`, `$htpasswdEncoding` and `$htpasswdFilename` in the TWiki.cfg file. The supported options are htpasswd:plain, htpasswd:crypt, htpasswd:sha1, htdigest:md5
3. **Copy** the [[TWikiRegistrationPub]] topic to [[TWikiRegistration]], overwriting old version of TWikiRegistration. Do that by either editing the topics in theTWiki web, or by renaming the `.txt` and `.txt,v` files in the `twiki/data/TWiki` directory.
- Customization:
- You can customize the registration form by deleting or adding input tags. The `name=""` parameter of the input tags must start with: `"Twk0..."` (if this is an optional entry), or `"Twk1..."` (if this is a required entry). This ensures that the fields are carried over into the user home page correctly.
- You can customize the default user home page in [[NewUserTemplate]]. The same variables get expanded as in the [[template topics|Main/TWikiTemplates#Template_Topics]]
- Register yourself in the [[TWikiRegistration]] topic.
- %X% **NOTE:** When a user registers, a new line with the username and encrypted password is added to the `data/.htpasswd` file. The `.htpasswd` file that comes with the TWiki installation includes user accounts for TWiki core team members that are used for testing on TWiki.org. You can edit the file and delete those lines.
- Create a new topic to check if authentication works.
- Edit the [[TWikiAdminGroup]] topic in the TWiki:Main web to include users with system administrator status.
- Edit the [[TWikiPreferences]] topic in the TWiki:TWiki web to set access privileges.
- Edit the [[WebPreferences]] topic in each web, if necessary: set access priviliges.
### WYSIWYG Editor
At this time, TWiki does not ship with an "what you see is what you get" editor. TWiki:Codev/IntegrateHtmlAreaEditor describes how to integrate an HTML editor.
%X% **NOTE:** User home topics are located in the %WIKITOOLNAME%.Main web - don't try to move them or create them in other webs. From any other web, user signatures have to point to %WIKITOOLNAME%.Main web, using a `Main.UserName` or `%MAINWEB%.UserName` format. (The `%MAINWEB%` variable is an advantage if you ever change the Main web name, but the standard `Main.UserName` is easier for users to enter, which is the bottom line!
## TWiki File System Info
See [[Appendix A: TWiki File System|Main/AppendixFileSystem]] for an installed system snapshot and descriptions of all files in the TWiki 01-Sep-2004 distribution.
-- TWiki:Main/PeterThoeny - 15 Aug 2004 %BR% -- TWiki:Main/MikeMannix - 16 May 2002