Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 175 lines (110 sloc) 6.686 kb
9bcd129 initial commit
adamfinden authored
1 # Symphony 2 #
2
3 - Version: 2.1.2
4 - Date: 20th Oct 2010
5 - Release Notes: <http://symphony-cms.com/download/releases/version/2.1.2/>
6 - Github Repository: <http://github.com/symphonycms/symphony-2/tree/2.1.2>
7
8
9 ## Overview
10
11 Symphony is a `PHP` & `MySQL` based CMS that utilises `XML` and `XSLT` as
12 its core technologies. This repository represents version "2.1.2" and is
13 considered stable.
14
15 Visit the forum at <http://symphony-cms.com/discuss/>
16
17 ### Symphony Server Requirements
18
19 - PHP 5.2 or above
20 - PHP's LibXML module, with the XSLT extension enabled (--with-xsl)
21 - MySQL 4.1 or above
22 - An Apache or Litespeed webserver
23 - Apache's mod_rewrite module or equivalent
24
25 ## Updating From an Older Version
26
27 #### Versions Prior to 2.1
28
29 As of version `2.1`, Symphony stores passwords using the more secure
30 [SHA1](http://php.net/sha1) algorithm (previous versions used MD5).
31 When updating to 2.1, the primary user's login password will be reset
32 (the new password will be displayed by the updater—please note it).
33 **Please also note that all other users' passwords will no longer be valid
34 and will require a manual reset through Symphony's forgotten password feature.**
35 Alternatively, as an administrator, you can also change your users'
36 passwords on their behalf.
37
38 #### Versions Prior to 2.0.5
39
40 Version `2.0.5` introduced multiple includable elements, in the Data Source
41 Editor, for a single field. After updating from `2.0.5` or lower, the DS
42 editor will seem to "forget" about any `Textarea` fields selected when you
43 are editing existing Data Sources. After updating, you must ensure you
44 re-select them before saving. Note, this will only effect Data Sources that
45 you edit and were created prior to `2.0.5`. Until that point, the field will
46 still be included in any front-end XML
47
48 ### Via Git
49
50 #### Versions Prior to 2.1
51
52 As of version 2.1, we are now using [GitHub's organisations feature](http://github.com/blog/674-introducing-organizations).
53 As a result, all submodules—as well as the main Symphony 2 repo—are forks owned by the
54 [Symphony CMS organisation](http://github.com/symphonycms/).
55
56 To fully update your git-based installation, please **edit your `.git/config`
57 and the `.git/config` of each core extension** (`debugdevkit`, `profiledevkit`,
58 `markdown`, `maintenance_mode`, `selectbox_link_field`, `jit_image_manipulation`
59 and `export_ensemble`) and change the URL of the remote repo from `symphony` or
60 `pointybeard` to be `symphonycms`.
61
62 For example:
63
64 [remote "origin"]
65 fetch = +refs/heads/*:refs/remotes/origin/*
66 url = git://github.com/pointybeard/markdown.git
67
68 Change `git://github.com/pointybeard/markdown.git` to `git://github.com/symphonycms/markdown.git`
69
70 1. Pull from the master branch at `git://github.com/symphonycms/symphony-2.git`
71
72 2. Use the following command to get Extensions up to date:
73
74 git submodule init
75 git submodule update
76
77 3. If updating from a version older than `2.0.5`, enable [Debug DevKit](http://github.com/symphonycms/debugdevkit/tree/master) and [Profile DevKit](http://github.com/symphonycms/profiledevkit/tree/master) extensions.
78
79 3. Go to `http://yoursite.com/update.php` to complete the update process.
80
81 4. You and your website are now in the future. Buy yourself a silver jumpsuit.
82
83 ### Via the old fashioned way
84
85 Follow the instructions below if you are updating from Symphony version 2.0 (not from Git)
86
87 **Note:** As of 2.0.6, there is no longer a need to backup `/symphony/.htaccess`.
88
89 1. Upload `/symphony`, `index.php` & `update.php`, replacing what is already on your server.
90
91 2. If you are updating from a version older than 2.0.5, download and install the Debug DevKit and Profile DevKit:
92
93 - [Debug DevKit](http://github.com/symphonycms/debugdevkit/tree/master)
94 - [Profile DevKit](http://github.com/symphonycms/profiledevkit/tree/master)
95
96 3. Go to `http://yoursite.com/update.php` to complete the update process.
97
98 4. Call a friend and brag that your copy of Symphony is newer than theirs.
99
100
101 ## Installing Symphony
102
103 ### Via Git
104
105 1. Clone the git repository to the location you desire using:
106
107 git clone git://github.com/symphonycms/symphony-2.git
108
109 Should you wish to make contributions back to the project, fork the master tree rather than cloning, and issue pull requests via github.
110
111 The following repositories are included as submodules:
112
113 - [Markdown](http://github.com/symphonycms/markdown)
114 - [Maintenance Mode](http://github.com/symphonycms/maintenance_mode)
115 - [Select Box Link Field](http://github.com/symphonycms/selectbox_link_field)
116 - [JIT Image Manipulation](http://github.com/symphonycms/jit_image_manipulation)
117 - [Export Ensemble](http://github.com/symphonycms/export_ensemble)
118 - [Debug DevKit](http://github.com/symphonycms/debugdevkit/tree/master)
119 - [Profile DevKit](http://github.com/symphonycms/profiledevkit/tree/master)
120 - [XSS Filter](http://github.com/symphonycms/xssfilter/tree/master)
121
122 3. Run the following command to ensure the submodules are cloned:
123
124 git submodule update --init
125
126 4. _(Optional)_ If you would like the [default ensemble](http://github.com/symphonycms/workspace/tree) installed as well,
127 you will need to use the following command from within the Symphony 2 folder you just created:
128
129 git clone git://github.com/symphonycms/workspace.git
130
131 5. Point your web browser at <http://yourwebsite.com/install.php> and provide
132 details for establishing a database connection and about your server environment.
133
134 6. Chuckle villainously and tap your fingertips together (or pet a cat) as your installation completes.
135
136
137 ### Via the old fashioned way
138
139 **Note: You can leave `/workspace` out if you do not want the default theme.**
140
141 1. This step assumes you downloaded a zip archive from the [Symphony website](http://symphony-cms.com).
142 Upload the following files and directories to the root directory of your website:
143
144 - index.php
145 - install.php
146 - install.sql
147 - /symphony
148 - /workspace
149 - /extensions
150
151 2. Point your web browser at <http://yourwebsite.com/install.php> and provide
152 details for establishing a database connection and about your server environment.
153
154 3. Pose like you're being filmed for a dramatic close-up while your installation completes.
155
156
157 ## Security
158
159 **Secure Production Sites: Change permissions and remove installer files.**
160
161 1. For a smooth install process, change permissions for the `root` and `workspace` directories.
162
163 cd /your/site/root
164 chmod -R 777 workspace
165
166 2. Once successfully installed, change permissions as per your server preferences, E.G.
167
168 chmod 755 .
169
170 3. Remove installer files (unless you're fine with revealing all your trade secrets):
171
172 rm install.php install.sql workspace/install.sql update.php
173
174 4. Dance like it's 2012!
Something went wrong with that request. Please try again.