| 13 | | Although a database backup will be implicitly created by default when upgrading the environment, it is always a good idea to perform a full backup of the environment using the [TracBackup hotcopy] command before beginning. |
| 14 | | |
| 15 | | === 2. Update the Trac Code #UpdatetheTracCode |
| 16 | | |
| 17 | | Get the new version as described in TracInstall, or through your operating system package manager. |
| 18 | | |
| 19 | | If you already an earlier version of Trac installed via `easy_install`, it might be easiest to also use `easy_install` to upgrade your Trac installation: |
| 20 | | |
| 21 | | {{{#!sh |
| 22 | | easy_install --upgrade Trac==1.2 |
| 23 | | }}} |
| 24 | | |
| 25 | | You may also want to remove the pre-existing Trac code by deleting the `trac` directory from the Python `lib/site-packages` directory, or remove Trac `.egg` files from former versions. |
| 26 | | The location of the site-packages directory depends on the operating system and the location in which Python was installed. However, the following locations are typical: |
| 27 | | * on Linux: `/usr/lib/python2.X/site-packages` |
| 28 | | * on Windows: `C:\Python2.X\lib\site-packages` |
| 29 | | * on MacOSX: `/Library/Python/2.X/site-packages` |
| 30 | | |
| 31 | | You may also want to remove the directory in which your static resources are [TracInstall#cgi-bin deployed]. The exact location depends on your platform. This cleanup is not mandatory, but makes it easier to troubleshoot issues later on, as your installation is uncluttered by code or templates from a previous release that is not used anymore. As usual, make a backup before actually removing things. |
| 32 | | |
| 33 | | === 3. Upgrade the Trac Environment #UpgradetheTracEnvironment |
| 34 | | |
| 35 | | Environment upgrades are not necessary for minor version releases unless otherwise noted. |
| 36 | | |
| 37 | | After restarting, Trac should show the instances which need a manual upgrade via the automated upgrade scripts to ease the pain. These scripts are run via [TracAdmin trac-admin]: |
| 38 | | {{{#!sh |
| 39 | | trac-admin /path/to/projenv upgrade |
| | 23 | Although a database backup will be implicitly created by default when upgrading the environment, it is always a good idea to perform a full backup of the environment using the [TracBackup hotcopy] command before beginning. You may also wish to create a full backup of your server. |
| | 24 | |
| | 25 | === 3. Update Trac and dependencies #UpdatetheTracCode |
| | 26 | |
| | 27 | The packages are available through several channels, as described in [trac:TracDownload]. If your Trac instance was installed through an operating system package manager, proceed with the standard steps that are appropriate for your operating system package manager. If it was installed through a Windows installer, uninstall the old Trac package before installing new Trac package. |
| | 28 | |
| | 29 | If you are managing your Trac installation using command line tools, `pip` is the preferred tool to upgrade a Trac instance because it will uninstall the old version. The following command will upgrade your Trac installation using the package published to [https://pypi.python.org/pypi/Trac PyPI]. |
| | 30 | |
| | 31 | {{{#!sh |
| | 32 | $ pip install --upgrade Trac |
| | 33 | }}} |
| | 34 | |
| | 35 | The upgrade command will give you the latest release of Trac. If instead you wish to upgrade to a different version, such as a minor release of Trac when there is a newer major release available, then specify the Trac version in the `pip` command. |
| | 36 | |
| | 37 | {{{#!sh |
| | 38 | $ pip install --upgrade Trac==1.4.1 |
| | 39 | }}} |
| | 40 | |
| | 41 | You should also upgrade dependencies so they are compliant with the [TracInstall#Dependencies required versions]. |
| | 42 | |
| | 43 | === 4. Upgrade the Trac Environment #UpgradetheTracEnvironment |
| | 44 | |
| | 45 | Environment upgrades are not necessary for minor version releases unless otherwise noted. |
| | 46 | |
| | 47 | On starting your web server after upgrading Trac, a message will be displayed for projects that need to be upgraded and the projects will not be accessible until the upgrade is run. |
| | 48 | |
| | 49 | The upgrade is run using a [TracAdmin trac-admin] command: |
| | 50 | {{{#!sh |
| | 51 | $ trac-admin /path/to/projenv upgrade |
| 44 | | Note that a backup of your database will be performed automatically prior to the upgrade. |
| 45 | | This feature is relatively new for PostgreSQL or MySQL databases, so if it fails, you will have to backup the database manually. Then, to perform the actual upgrade: |
| 46 | | {{{#!sh |
| 47 | | trac-admin /path/to/projenv upgrade --no-backup |
| 48 | | }}} |
| 49 | | |
| 50 | | === 4. Update the Trac Documentation === #UpdatetheTracDocumentation |
| 51 | | |
| 52 | | By default, every [TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. However, to keep the included documentation in sync with the installed version of Trac, use the following [TracAdmin trac-admin] command to upgrade the documentation: |
| 53 | | {{{#!sh |
| 54 | | trac-admin /path/to/projenv wiki upgrade |
| 55 | | }}} |
| 56 | | |
| 57 | | Note that this procedure will leave your `WikiStart` page intact. |
| 58 | | |
| 59 | | === 5. Refresh static resources |
| 60 | | |
| 61 | | If you have set up a web server to give out static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the same command: |
| 62 | | {{{#!sh |
| 63 | | trac-admin /path/to/env deploy /deploy/path |
| 64 | | }}} |
| 65 | | |
| 66 | | This will extract static resources and CGI scripts (`trac.wsgi`, etc) from new Trac version and its plugins into `/deploy/path`. |
| 67 | | |
| 68 | | Some web browsers (IE, Opera) cache CSS and Javascript files aggressively, so you may need to instruct your users to manually erase the contents of their browser's cache, a forced refreshed (`<F5>`) should be enough. |
| | 56 | It is recommended that you set the [[TracIni#logging-log_level-option|log_level]] to `INFO` before running the upgrade. The additional information in the logs can be helpful in case something unexpected occurs during the upgrade. |
| | 57 | |
| | 58 | Note that a backup of your database will be performed automatically prior to the upgrade. The backup is saved in the location specified by [[TracIni#trac-backup_dir-option|backup_dir]]. |
| | 59 | |
| | 60 | === 5. Update the Trac Documentation === #UpdatetheTracDocumentation |
| | 61 | |
| | 62 | By default, every [TracEnvironment Trac environment] includes a copy of the Trac documentation for the installed version. To keep the documentation in sync with the installed version of Trac, upgrade the documentation: |
| | 63 | {{{#!sh |
| | 64 | $ trac-admin /path/to/projenv wiki upgrade |
| | 65 | }}} |
| | 66 | |
| | 67 | Note that this procedure will leave your `WikiStart`, `InterMapTxt` and `SandBox` pages unaltered. Local changes to other pages that are distributed with Trac will be overwritten, however these pages are read-only by default for Environments created in Trac 1.3.3 and later. |
| | 68 | |
| | 69 | === 6. Refresh static resources |
| | 70 | |
| | 71 | If you have configured your web server to serve static resources directly (accessed using the `/chrome/` URL) then you will need to refresh them using the [TracInstall#MappingStaticResources deploy command]. The `deploy` command will extract static resources and CGI scripts (`trac.wsgi`, etc) from the new Trac version and plugins into `/deploy/path`. |
| | 72 | {{{#!sh |
| | 73 | $ trac-admin /path/to/env deploy /deploy/path |
| | 74 | }}} |
| | 75 | |
| | 76 | Before refreshing, it is recommended that you remove the directory in which your static resources are deployed. The directory location depends on the choice you made during installation. This cleanup is not mandatory, but makes it easier to troubleshoot issues as your installation is uncluttered by unused assets from a previous release. As usual, make a backup before deleting the directory. |
| | 77 | |
| | 78 | {{{#!div style="border: 1pt dotted; margin: 1em" |
| | 79 | **Note:** Some web browsers (IE, Opera) cache CSS and !JavaScript files, so you should instruct your users to manually erase the contents of their browser's cache. A forced refreshed (SHIFT + <F5>) should be sufficient. |
| 72 | | |
| 73 | | === 6. Steps specific to a given Trac version |
| | 83 | }}} |
| | 84 | |
| | 85 | === 7. Steps specific to a given Trac version #VersionSpecificSteps |
| | 86 | |
| | 87 | ==== Upgrading from Trac 1.4 to 1.5 #to1.5 |
| | 88 | |
| | 89 | ===== Python 2.7 no longer supported |
| | 90 | |
| | 91 | Upgrade Python to 3.5 or later. |
| | 92 | |
| | 93 | ==== Upgrading from Trac 1.2 to 1.4 #to1.4 |
| | 94 | |
| | 95 | ===== Python 2.6 no longer supported |
| | 96 | |
| | 97 | Upgrade Python to 2.7, but not 3.0 or greater. |
| | 98 | |
| | 99 | ===== MySQL-python no longer supported |
| | 100 | |
| | 101 | [https://pypi.python.org/pypi/PyMySQL PyMySQL] is the supported MySQL database library, support for [https://pypi.python.org/pypi/MySQL-python MySQL-python] has been removed. |
| | 102 | |
| | 103 | ===== Obsolete Plugins |
| | 104 | |
| | 105 | Trac has added functionality equivalent to the following plugins: |
| | 106 | |
| | 107 | * [https://trac-hacks.org/wiki/DynamicVariablesPlugin DynamicVariablesPlugin]: dynamic variables are autocompleted |
| | 108 | * [https://trac-hacks.org/wiki/NavAddPlugin NavAddPlugin]: see TracNavigation |
| | 109 | * [https://trac-hacks.org/wiki/FlexibleAssignToPlugin FlexibleAssignToPlugin]: subclass `ConfigurableTicketWorkflow` and override `get_allowed_owners` |
| | 110 | * [https://trac-hacks.org/wiki/TracMigratePlugin TracMigratePlugin]: Use the `trac-admin` [TracAdmin#ChangingDatabaseBackend convert_db command] |
| | 111 | |
| | 112 | The plugins should be removed when upgrading Trac to 1.4. |
| | 113 | |
| | 114 | ===== Jinja2 is the new template engine |
| | 115 | |
| | 116 | Content is now generated by using the Jinja2 template |
| | 117 | engine. You should verify that your plugins are |
| | 118 | compatible with this change. |
| | 119 | |
| | 120 | If you customized the Trac templates, or the `site.html` |
| | 121 | template, you'll need to adapt that as well. |
| | 122 | (TODO: expand...) See [#CustomizedTemplates]. Email [TracNotification#CustomizingContent notification templates] also need to |
| | 123 | be adapted. |
| | 124 | |
| | 125 | ===== New permission policies for Wiki and Ticket realms |
| | 126 | |
| | 127 | Since 1.3.2 there are new permission policies for the ticket and wiki systems. `DefaultTicketPolicy` allows an authenticated user with `TICKET_APPEND` or `TICKET_CHPROP` to modify the description of a ticket they reported. It also implements the pre-1.3.2 behavior of allowing users to edit their own ticket comments. [#Newpermissionspolicyforread-onlywikipages ReadonlyWikiPolicy], added in 1.1.2, is renamed to `DefaultWikiPolicy`. The new permission policies can be easily replaced with alternate implementations if the default behavior is not desired. |
| | 128 | |
| | 129 | If `[trac] permission_policy` has the default value `ReadonlyWikiPolicy, DefaultPermissionPolicy, LegacyAttachmentPolicy`, then `DefaultWikiPolicy, DefaultTicketPolicy` should be automatically appended to the list when upgrading the environment: |
| | 130 | {{{#!ini |
| | 131 | [trac] |
| | 132 | permission_policies = DefaultWikiPolicy, |
| | 133 | DefaultTicketPolicy, |
| | 134 | DefaultPermissionPolicy, |
| | 135 | LegacyAttachmentPolicy |
| | 136 | }}} |
| | 137 | |
| | 138 | If other permission policies are enabled, `trac.ini` will need to be edited to add `DefaultWikiPolicy, DefaultTicketPolicy` to `permission_policies`. See [wiki:TracFineGrainedPermissions#DefaultWikiPolicyandDefaultTicketPolicy] for additional details on the proper ordering. |
| | 139 | |
| | 140 | ===== Description field added to ticket enums #enum-description-field |
| | 141 | |
| | 142 | The ticket enums now have a //description// field. An //ambiguous column name// error may be seen for reports that reference the `description` column of another table and join the `enum` table with that table (e.g. `ticket`, `component`). The reports {1}, {2}, {3}, {4}, {5}, {7}, and {8} are modified by an upgrade step to fix the issue, but the modification may not succeed if the default reports have been modified, in which case `upgrade` will output a message to the terminal instructing the user to modify the reports. User-created reports may also need to be modified. |
| | 143 | |
| | 144 | Reports that display the error need to be modified to prefix the `description` column with the appropriate table name or alias. For example, if the `ticket` table is aliased as `t` (`ticket t` or `ticket AS t`), replace `description` with `t.description` if the report should use the ticket's `description` column. |
| | 145 | |
| | 146 | ===== Removed `<repostype>` and `<repospath>` arguments from `trac-admin` `initenv` command |
| | 147 | |
| | 148 | The TracAdmin `initenv` command allowed the default repository to be specified using the third and fourth positional arguments of `initenv`: |
| | 149 | {{{#!sh |
| | 150 | initenv [<projectname> <db> [<repostype> <repospath>]] |
| | 151 | }}} |
| | 152 | |
| | 153 | The arguments were an artifact of Trac < 0.12, which only supported a single repository. Trac 0.12 and later supports multiple repositories, which can be specified at the time of environment creation using the `--inherit` and `--config` arguments. See the [TracEnvironment#SourceCodeRepository initenv documentation] for details on specifying source code repositories. |
| 144 | | ==== Upgrading from Trac 0.11 to Trac 0.12 |
| 145 | | |
| 146 | | ===== Python 2.3 no longer supported |
| 147 | | |
| 148 | | The minimum supported version of Python is now 2.4. |
| 149 | | |
| 150 | | ===== SQLite v3.x required |
| 151 | | |
| 152 | | SQLite v2.x is no longer supported. If you still use a Trac database of this format, you'll need to convert it to SQLite v3.x first. See [trac:PySqlite#UpgradingSQLitefrom2.xto3.x] for details. |
| 153 | | |
| 154 | | ===== [trac:PySqlite] 2 required |
| 155 | | |
| 156 | | [trac:PySqlite] 1.1.x is no longer supported. Please install 2.5.5 or later if possible, see [#Tracdatabaseupgrade Trac database upgrade] below. |
| 157 | | |
| 158 | | ===== Obsolete Plugins |
| 159 | | |
| 160 | | Trac has added functionality equivalent to the following plugins: |
| 161 | | |
| 162 | | * [https://trac-hacks.org/wiki/AutoQueryPlugin AutoQueryPlugin] |
| 163 | | * [https://trac-hacks.org/wiki/AdminConsoleProviderPatch AdminConsoleProviderPatch] |
| 164 | | * [https://trac-hacks.org/wiki/AnchorMacro AnchorMacro]: see WikiFormatting#SettingAnchors |
| 165 | | * [https://trac-hacks.org/wiki/TicketChangePlugin TicketChangePlugin]: see [TracPermissions#TicketSystem TICKET_EDIT_COMMENT permission] |
| 166 | | * [https://trac-hacks.org/wiki/TicketDeletePlugin TicketDeletePlugin]: see `tracopt.ticket.deleter` |
| 167 | | * [https://trac-hacks.org/wiki/SubversionLocationPlugin SubversionLocationPlugin]: see TracRepositoryAdmin#Repositories |
| 168 | | * [https://trac-hacks.org/wiki/WikiCreoleRendererPlugin WikiCreoleRendererPlugin]: see [trac:WikiCreole] |
| 169 | | * [https://trac-hacks.org/wiki/RepoRevisionSyntaxPlugin RepoRevisionSyntaxPlugin] (added in 0.12.1) |
| 170 | | |
| 171 | | The plugins should be removed when upgrading Trac to 0.12. |
| 172 | | |
| 173 | | ===== Multiple Repository Support |
| 174 | | |
| 175 | | The latest version includes support for multiple repositories. If you plan to add more repositories to your Trac instance, please refer to TracRepositoryAdmin#Migration. |
| 176 | | |
| 177 | | This may be of interest to users with only one repository, since there is now a way to avoid the potentially costly resync check at every request. |
| 178 | | |
| 179 | | ===== Resynchronize the Trac Environment Against the Source Code Repository |
| 180 | | |
| 181 | | Each [TracEnvironment Trac environment] must be resynchronized against the source code repository in order to avoid errors such as "[trac:#6120 No changeset ??? in the repository]" while browsing the source through the Trac interface: |
| 182 | | |
| 183 | | {{{#!sh |
| 184 | | trac-admin /path/to/projenv repository resync '*' |
| 185 | | }}} |
| 186 | | |
| 187 | | ===== Improved repository synchronization |
| 188 | | |
| 189 | | In addition to supporting multiple repositories, there is now a more efficient method for synchronizing Trac and your repositories. |
| 190 | | |
| 191 | | While you can keep the same synchronization as in 0.11 adding the post-commit hook as outlined in TracRepositoryAdmin#Synchronization and TracRepositoryAdmin#ExplicitSync will allow more efficient synchronization and is more or less required for multiple repositories. |
| 192 | | |
| 193 | | Note that if you were using the `trac-post-commit-hook`, ''you're strongly advised to upgrade it'' to the new hook documented in the above references and [TracWorkflow#Howtocombinethetracopt.ticket.commit_updaterwiththetestingworkflow here], as the old hook will not work with anything else than the default repository and even for this case, it won't trigger the appropriate notifications. |
| 194 | | |
| 195 | | ===== Authz permission checking |
| 196 | | |
| 197 | | The authz permission checking has been migrated to a fine-grained permission policy. If you use authz permissions (aka `[trac] authz_file` and `authz_module_name`), you must add `AuthzSourcePolicy` in front of your permission policies in `[trac] permission_policies`. You must also remove `BROWSER_VIEW`, `CHANGESET_VIEW`, `FILE_VIEW` and `LOG_VIEW` from your global permissions with `trac-admin $ENV permission remove` or the "Permissions" admin panel. |
| 198 | | |
| 199 | | ===== Microsecond timestamps |
| 200 | | |
| 201 | | All timestamps in database tables, except the `session` table, have been changed from "seconds since epoch" to "microseconds since epoch" values. This change should be transparent to most users, except for custom reports. If any of your reports use date/time columns in calculations (e.g. to pass them to `datetime()`), you must divide the values retrieved from the database by 1'000'000. Similarly, if a report provides a calculated value to be displayed as a date/time (i.e. with a column named "time", "datetime", "changetime", "date", "created" or "modified"), you must provide a microsecond timestamp, that is, multiply your previous calculation with 1'000'000. |
| 202 | | |
| 203 | | ==== Upgrading from Trac 0.10 to Trac 0.11 |
| 204 | | |
| 205 | | ===== Site Templates and Styles |
| 206 | | |
| 207 | | The templating engine has changed in 0.11 to Genshi, please look at TracInterfaceCustomization for more information. |
| 208 | | |
| 209 | | If you are using custom CSS or modified templates in the `templates` directory of the TracEnvironment, you will need to convert them to the Genshi way of doing things. To continue to use your style sheet, follow the instructions at TracInterfaceCustomization#SiteAppearance. |
| 210 | | |
| 211 | | ===== Trac Macros, Plugins |
| 212 | | |
| 213 | | The Trac macros will need to be adapted, as the old-style wiki-macros are not supported anymore due to the drop of [trac:ClearSilver] and the HDF. They need to be converted to the new-style macros, see WikiMacros. When they are converted to the new style, they need to be placed into the plugins directory instead and not wiki-macros, which is no longer scanned for macros or plugins. |
| 214 | | |
| 215 | | ===== For FCGI/WSGI/CGI users |
| 216 | | |
| 217 | | For those who run Trac under the CGI environment, run this command in order to obtain the trac.*gi file: |
| 218 | | {{{#!sh |
| 219 | | trac-admin /path/to/env deploy /deploy/directory/path |
| 220 | | }}} |
| 221 | | |
| 222 | | This will create a deploy directory with the following two subdirectories: `cgi-bin` and `htdocs`. Then update your Apache configuration file `httpd.conf` with this new `trac.cgi` location and `htdocs` location. |
| 223 | | |
| 224 | | ===== Web Admin plugin integrated |
| 225 | | |
| 226 | | If you had the [trac:WebAdmin] plugin installed, you can uninstall it as it is part of the Trac code base since 0.11. |
| 227 | | |
| 228 | | ===== New Default Configurable Workflow |
| 229 | | |
| 230 | | When you run `trac-admin <env> upgrade`, your `trac.ini` will be modified to include a `[ticket-workflow]` section. The workflow configured in this case is the original workflow, so that ticket actions will behave like they did in 0.10: |
| 231 | | |
| 232 | | {{{#!Workflow width=500 height=240 |
| 233 | | leave = * -> * |
| 234 | | leave.operations = leave_status |
| 235 | | leave.default = 1 |
| 236 | | accept = new -> assigned |
| 237 | | accept.permissions = TICKET_MODIFY |
| 238 | | accept.operations = set_owner_to_self |
| 239 | | resolve = new,assigned,reopened -> closed |
| 240 | | resolve.permissions = TICKET_MODIFY |
| 241 | | resolve.operations = set_resolution |
| 242 | | reassign = new,assigned,reopened -> new |
| 243 | | reassign.permissions = TICKET_MODIFY |
| 244 | | reassign.operations = set_owner |
| 245 | | reopen = closed -> reopened |
| 246 | | reopen.permissions = TICKET_CREATE |
| 247 | | reopen.operations = del_resolution |
| 248 | | }}} |
| 249 | | |
| 250 | | There are some significant caveats in this, such as accepting a ticket sets it to 'assigned' state, and assigning a ticket sets it to 'new' state. So you will probably want to migrate to "basic" workflow; [trac:source:trunk/contrib/workflow/migrate_original_to_basic.py contrib/workflow/migrate_original_to_basic.py] may be helpful. See TracWorkflow for a detailed description of the new basic workflow. |
| 251 | | |
| 252 | | === 7. Restart the Web Server #RestarttheWebServer |
| 253 | | |
| 254 | | If you are not running [wiki:TracCgi CGI], reload the new Trac code by restarting your web server. |
| | 243 | ===== Behavior of `* -> *` workflow transition |
| | 244 | |
| | 245 | The workflow transition `* -> *` must have the operation |
| | 246 | `leave_status`. Due to a defect in Trac < 1.0.18 |
| | 247 | `leave_status` was not required, so it may be necessary |
| | 248 | to add the operation when upgrading. The action will not |
| | 249 | display for a `* -> *` transition if the action does |
| | 250 | not have the `leave_status` operation. |
| | 251 | |
| | 252 | ==== Upgrading from older versions of Trac #OlderVersions |
| | 253 | |
| | 254 | For upgrades from versions older than Trac 0.12, refer first to [trac:wiki:0.12/TracUpgrade#SpecificVersions TracUpgrade for 0.12]. |
| | 255 | |
| | 256 | For upgrades from versions older than Trac 0.10, refer first to [trac:wiki:0.10/TracUpgrade#SpecificVersions TracUpgrade for 0.10]. |
