tonyair
/
silverstripe-subsites
mirror of https://github.com/silverstripe/silverstripe-subsites
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

MINOR Improved README structure, wording and formatting

This commit is contained in:
Ingo Schommer 2011-09-09 10:31:32 +02:00
parent 47c545f658
commit 0cf41dcc15
1 changed files with 19 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

57
README.md
View File

@ -8,49 +8,18 @@ The subsites module allows multiple websites to run from a single installation o
* SilverStripe 2.3
## Download
subsites doesn't currently have a stable release. If you would like to use it, you should download the "trunk" version.
If you have subversion, you do this by executing ''svn checkout http://svn.silverstripe.com/open/modules/subsites/trunk subsites'' within your project folder.
If you don't have subversion, you can [download a ZIP file](http://open.silverstripe.com/changeset/latest/modules/subsites/trunk?old_path=/&filename=/modules/subsites/trunk&format=zip) and copy the ''modules/subsites/trunk'' folder into your project folder, and rename it to ''subsites''.
For SilverStripe versions 2.3.x this forum entry might be useful in getting the compatible sources, since the trunk is probably using SS 2.4 API by now: [Successful installation of Subsites module on SS 2.3.0 (2.3.7 seems feasible)](http://www.silverstripe.org/all-other-modules/show/281695#post281695)
## Installation
* Visit the URL ''db/build?flush=1'' on your site; eg, http://localhost/mysite/db/build?flush=1 or http://www.example.com/db/build?flush=1 - you should see a Subsite table created, among other things.
* Once that has finished running, open the CMS. You should now see Subsites on the main menu. Click it to open the subsite administrator.
* Create a new subsite, giving it a name and a subdomain. The subdomain will determine the URL of your website. For example, if your site is running on http://localhost/mysite, and you set the subdomain to "subsite", then your subsite will be accessible on http://subsite.localhost/mysite
* Once you have created and saved your new subsite, go back to the Site Content section. In the top-right, there should be a dropdown listing the two subsites - "Main site" is the original site that you had before you installed the subsites module. Select your new subsite, and the site content tree will be updated. It should be empty at this stage.
* Create necessary tables by visiting `http://<yoursite>/dev/build` (you should see a `Subsite` table created, among other things). You don't need to run this command for every subsite.
* Login to the CMS as an administrator. You should now see a "Subsites" entry on the main menu.
* Create a new subsite, giving it a name and a subdomain. The subdomain will determine the URL of your website. For example, if your site is running on `http://localhost/mysite`, and you set the subdomain to "subsite", then your subsite will be accessible on `http://subsite.localhost/mysite`
* Once you have created and saved your new subsite, go back to the "Site Content" section. In the top-right, there should be a dropdown listing the two subsites - "Main site" is the original site that you had before you installed the subsites module. Select your new subsite, and the site content tree will be updated. It should be empty at this stage.
* Add a page - change its title to "Home", and its URL Segment will be changed to "home". Save the page.
* Update your DNS and, if necessary, your webserver configuration, so that your subdomain will point to the SilverStripe installation on your webserver. Visit this new subdomain. You should see the new subsite homepage.
## Usage
### Download new themes
Download a second theme from http://www.silverstripe.com/themes/ and put it in your themes folder. Open admin/subsites?flush=1 and select one of your subsites from the menu on the bottom-left. You should see a Theme dropdown in the subsite details, and it should list both your original theme and the new theme. Select the new theme in the dropdown. Now, this subsite will use a different theme from the main site.
### Limit themes for a subsite
Not all themes might be suitable or adapted for all subsites. You can optionally limit usage of themes:
*mysite/_config.php*
:::php
Subsite::set_allowed_themes(array('blackcandy','mytheme'));
### Set the domains for your subsites
### Limit allowed domains
You can list available domains for your subsites (Example: subdomain.''domain''.tld). The subsites are generally identified only by their subdomain part (Example: ''subdomain''.domain.tld).
@ -65,7 +34,7 @@ This example would let you create subsites such as ''wellington.mycompany.com''
));
If you would like to be able to choose any domain for your subsite, rather than subdomains off a common base, then list top-level domains in your ''set_allowed_domains()'' list.
If you would like to be able to choose any domain for your subsite, rather than subdomains off a common base, then list top-level domains in your `set_allowed_domains()` list.
In this example, your subsite name (e.g. ''silverstripe''), will be appended to a much shorter base domain (e.g. ''co.nz'', or ''org''). This would let you create subsites with domains such as ''silverstripe.org'' or ''example.co.nz''
@ -108,11 +77,23 @@ together with the `ADMIN` permission.
Once you have created some subsites/domains in your admin, you can check the overall functionality of subsites by
http://your.primary-domain.com/subsite-metadata-url?SubsiteID=1
In some Browsers the SubsiteID is visible if you hover over the "Edit" link in the search results of Subsite admin.
### Subsite-specific themes
Download a second theme from http://www.silverstripe.com/themes/ and put it in your themes folder. Open admin/subsites?flush=1 and select one of your subsites from the menu on the bottom-left. You should see a Theme dropdown in the subsite details, and it should list both your original theme and the new theme. Select the new theme in the dropdown. Now, this subsite will use a different theme from the main site.
### Limit available themes for a subsite
Not all themes might be suitable or adapted for all subsites. You can optionally limit usage of themes:
*mysite/_config.php*
:::php
Subsite::set_allowed_themes(array('blackcandy','mytheme'));
## Screenshots
![](docs/en/_images/subsites-module-adminscreenshot-new.png)