Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
howto:ecweb [2012/08/31 01:24] – [modopts.ini] style update digitalman | howto:ecweb [2019/05/09 01:54] – [See Also] Added a tag digital man | ||
---|---|---|---|
Line 1: | Line 1: | ||
====== Configure and Customize ecWeb ====== | ====== Configure and Customize ecWeb ====== | ||
- | ecWeb is a replacement for Synchronet' | + | The version |
- | + | ||
- | =====Requirements===== | + | |
- | + | ||
- | The components | + | |
- | + | ||
- | * [[dir: | + | |
- | * [[dir: | + | |
- | * [[dir: | + | |
- | * [[dir: | + | |
- | * [[dir: | + | |
- | * [[dir: | + | |
- | + | ||
- | =====Configuration===== | + | |
- | + | ||
- | ====modopts.ini==== | + | |
- | + | ||
- | Certain configuration values for ecWeb are stored in the '' | + | |
- | + | ||
- | [web] | + | |
- | ;ecWeb config options | + | |
- | RootDirectory = / | + | |
- | WebGuest = Guest | + | |
- | appendURL = /ecwebv3/ | + | |
- | sessionTimeout = 43200 | + | |
- | captchaLength = 5 | + | |
- | maxMessages = 0 | + | |
- | + | ||
- | === RootDirectory === | + | |
- | This key specifies the location of the web-accessible components of ecWeb. | + | |
- | + | ||
- | === WebGuest === | + | |
- | This key defines the alias of the account to be used for all unauthenticated browsing. | + | |
- | + | ||
- | === appendURL === | + | |
- | This key is a kludge that's required to make ecWeb' | + | |
- | + | ||
- | === sessionTimeout === | + | |
- | This key defines, in seconds, how long a user will remain logged in during periods of inactivity. | + | |
- | + | ||
- | === captchaLength === | + | |
- | This key determines how many characters will be shown in the ANSI/ASCII art CAPTCHA on the new-user signup page. | + | |
- | + | ||
- | === maxMessages === | + | |
- | This key specifies how many of a sub-board' | + | |
- | + | ||
- | ====Flash Socket Policy Server==== | + | |
- | + | ||
- | (You can ignore this section if you don't want to offer fTelnet or lightIRC on your website.) | + | |
- | + | ||
- | ecWeb includes fTelnet by Rick Parrish and lightIRC by Valentin Manthei. | + | |
- | + | ||
- | [FlashPolicy] | + | |
- | Port=843 | + | |
- | MaxClients=10 | + | |
- | Options=NO_HOST_LOOKUP | + | |
- | Command=flashpolicyserver.js | + | |
- | + | ||
- | This means that connections to port 843 of your BBS host will be handled by the script ' | + | |
- | + | ||
- | Now return to [[dir: | + | |
- | + | ||
- | fTelnet also includes HTMLTerm, which is an HTML5 telnet application. | + | |
- | + | ||
- | [WebSocket] | + | |
- | Port=1123 | + | |
- | Options=NO_HOST_LOOKUP | + | |
- | Command=websocketservice.js | + | |
- | + | ||
- | (And don't forget to forward port 1123 to your BBS machine.) | + | |
- | + | ||
- | Recycle your services (or simply restart your BBS) so that these configuration changes will take effect. | + | |
- | + | ||
- | ====Testing==== | + | |
- | + | ||
- | At this point in the configuration, | + | |
- | + | ||
- | To begin, navigate to: | + | |
- | + | ||
- | http:// | + | |
- | + | ||
- | If all goes well, you'll see the ecWeb interface in its most plain and basic form. Now it's time to start customizing ecWeb and adding content to your site. | + | |
- | + | ||
- | =====Customization===== | + | |
- | + | ||
- | All paths referenced in this section are relative to ecWeb' | + | |
- | + | ||
- | ====style/ | + | |
- | + | ||
- | This file is your ecWeb stylesheet. | + | |
- | + | ||
- | If you want to change the colours, borders, spacing and certain aspects of the layout of your ecWeb installation, | + | |
- | + | ||
- | * body | + | |
- | The overall page. " | + | |
- | + | ||
- | * a | + | |
- | * a:link | + | |
- | * a: | + | |
- | * a: | + | |
- | * a:active | + | |
- | The style of links (except for in the forum) by default, when visited, when being hovered over, when being clicked upon, etc. | + | |
- | + | ||
- | * .ulLink | + | |
- | * .ulLink: | + | |
- | * .ulLink: | + | |
- | * .ulLink: | + | |
- | * .ulLink: | + | |
- | Same as ' | + | |
- | + | ||
- | * # | + | |
- | This ruleset is applied to the element that holds all other elements on the page (the header, sidebar, main content and footer.) | + | |
- | + | ||
- | * #header | + | |
- | These rules are applied to the header (ie. where the name of your BBS appears at the top of the page by default.) | + | |
- | + | ||
- | * #content | + | |
- | This is the main content section of the page. If you want to use a different font or background colour here for some reason, you could define some rules herein. | + | |
- | + | ||
- | * #sidebar | + | |
- | This is the box that contains the sidebar widgets (an important distinction.) | + | |
- | + | ||
- | * #footer | + | |
- | This is the footer of the page, where by default the version notice for your system appears. | + | |
- | + | ||
- | * .font | + | |
- | I opted to define a .font class so that I could apply it to everything, including input boxes and textareas. | + | |
- | + | ||
- | * .border | + | |
- | This is the border that's placed around various types of elements. | + | |
- | + | ||
- | * .box | + | |
- | The ' | + | |
- | + | ||
- | * .indentBox1 | + | |
- | * .indentBox2 | + | |
- | * .indentBox3 | + | |
- | The indentBox rules (1, 2, and 3) are used in the message forum to specify indentation of sub-board titles, message threads, and the messages within threads. | + | |
- | desired. | + | |
- | + | ||
- | * .background | + | |
- | This rule is applied to all boxes on your site with the exception of the ones in the message forum. | + | |
- | than the ' | + | |
- | + | ||
- | * .msg | + | |
- | Like ' | + | |
- | + | ||
- | * .sidebarItem | + | |
- | This rule applies to each sidebar widget individually. | + | |
- | + | ||
- | * .title | + | |
- | Page titles such as " | + | |
- | + | ||
- | ====The Sidebar==== | + | |
- | + | ||
- | You can add any number of sidebar widgets to your page by placing | + | |
- | + | ||
- | Default sidebar modules include: | + | |
- | + | ||
- | * 000-pages.ssjs | + | |
- | Scans the pages/ directory and generates a list of links to any non-hidden files therein | + | |
- | + | ||
- | * 001-login.ssjs | + | |
- | Provides a login form and a link to the registration page for unauthenticated users, a logout link and an email link to logged-in users. | + | |
- | + | ||
- | * 002-whosOnline.ssjs | + | |
- | A list of who's online on your BBS's terminal server. | + | |
- | + | ||
- | * 003-systemStats.xjs | + | |
- | A table of BBS info. | + | |
- | + | ||
- | ====Pages==== | + | |
- | + | ||
- | The pages/ directory may contain any number of .xjs, .html, .txt or .ssjs files. | + | |
- | + | ||
- | The first comment line of an XJS or HTML file will be used as its title, and will determine how (or if) it is listed in the " | + | |
- | + | ||
- | <!--The Phil File--> | + | |
- | + | ||
- | On the other hand, if you didn't want your page to show up in the list at all, you could put the word " | + | |
- | + | ||
- | < | + | |
- | + | ||
- | Of course, now if you want to share the link to this page with others, you'll need to reference it somehow. | + | |
- | + | ||
- | http://your-bbs-hostname.whatever/ | + | |
- | + | ||
- | This tells the main layout script of the site (index.xjs) that the user has requested a " | + | |
- | + | ||
- | In an SSJS file, the first comment line will determine its page title, so in this case you would make the first comment in the file read: | + | |
- | + | ||
- | //The Phil File | + | |
- | + | ||
- | or | + | |
- | + | ||
- | //HIDDEN | + | |
- | + | ||
- | In a .txt file, the first line of the document is treated as its title. | + | |
- | + | ||
- | See the pages/ | + | |
- | + | ||
- | ====Layout==== | + | |
- | + | ||
- | As mentioned previously, the file index.xjs is, in conjunction with style/ | + | |
- | + | ||
- | However, the purpose of this article is not to teach you how to write or modify HTML & XJS files. | + | |
- | + | ||
- | ====Setting ecWeb as your web interface==== | + | |
- | + | ||
- | Okay, so http://your-bbs-host.whatever/ | + | |
- | + | ||
- | In [[dir:ctrl]]/sbbs.ini, scroll to the [Web] section and change the value of the " | + | |
- | + | ||
- | RootDirectory = / | + | |
- | + | ||
- | (Alter that path according to where Synchronet is installed on your system, of course.) | + | |
- | + | ||
- | Then open [[dir: | + | |
- | + | ||
- | appendURL = / | + | |
- | + | ||
- | With this done, create an ' | + | |
- | + | ||
- | Recycle your webserver or restart your BBS. ecWeb should now be configured as your standard web interface. | + | |
===== See Also ===== | ===== See Also ===== | ||
* [[: | * [[: | ||
- | {{tag>}} | + | {{tag>ecweb}} |