Index: openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp =================================================================== RCS file: /usr/local/cvsroot/openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp,v diff -u -N -r1.5.2.9 -r1.5.2.10 --- openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp 27 Apr 2022 16:52:21 -0000 1.5.2.9 +++ openacs-4/packages/acs-core-docs/www/upgrade-openacs-files.adp 13 Jul 2023 12:43:23 -0000 1.5.2.10 @@ -1,17 +1,18 @@ -{/doc/acs-core-docs {ACS Core Documentation}} {Upgrading the OpenACS files} +{/doc/acs-core-docs/ {ACS Core Documentation}} {Upgrading the OpenACS files} Upgrading the OpenACS files

Upgrading the OpenACS files

-Choosing a Method to Upgrade your +Choosing a Method to Upgrade your Files

OpenACS is distributed in many different ways:

  • as a collection of files

  • as one big tarball

  • via CVS

  • via automatic download from within the APM (package manager)

Upgrades work by first changing the filesystem (via any of the @@ -21,18 +22,20 @@ filesystem for you. If you are using the last method, you can skip this page. This page describes whether or not you need to be upgrading using this page or not: the section -called “Upgrading an OpenACS 5.0.0 or greater installation” +called “Upgrading an OpenACS 5.0.0 or greater +installation”

-Methods of upgrading OpenACS files

    +Methods of upgrading OpenACS files

  • Upgrading files for a site which is not in a CVS -repository. Unpack the tarball into a new directory -and copy its contents on top of your working directory. Or just -'install software', select remote repository, and upgrade -your files from there.

    [root root]# su - $OPENACS_SERVICE_NAME
+repository. Unpack the tarball into a new
+directory and copy its contents on top of your working directory.
+Or just 'install software', select remote repository, and
+upgrade your files from there.
    +[root root]# su - $OPENACS_SERVICE_NAME
 
 [$OPENACS_SERVICE_NAME aolserver]$ cd /var/lib/aolserver
 [$OPENACS_SERVICE_NAME web]$ tar xzf /var/tmp/openacs-5-1.tar.gz
@@ -53,20 +56,20 @@
 version, without overriding your own local customizations.
    This diagram explains the basic idea. However, the labels are
 incorrect. Step 1(a) has been removed, and Step 1(b) should be
 labelled Step 1.
    
-
    Figure 5.2. Upgrading a local
-CVS repository
    Upgrading a local CVS repository
    
+
    Figure 5.2. Upgrading a local CVS
+repository
    Upgrading a local CVS repository
    
 

      
 
    • 
 
      
-Step 0: Set up a working CVS checkout. To
-get your OpenACS code into your local CVS repository, you will set
-up a working CVS checkout of OpenACS. When you want to update your
-site, you'll update the working CVS checkout, import those
-changes into your local CVS checkout, create a temporary CVS
-checkout to merge your local changes, fix any conflicts, commit
-your changes, and then update your site. It sounds complicated, but
-it's not too bad, and it is the best way to work around
-CVS's limitations.
      This part describes how to set up your working CVS checkout.
+Step 0: Set up a working CVS
+checkout. To get your OpenACS code into your
+local CVS repository, you will set up a working CVS checkout of
+OpenACS. When you want to update your site, you'll update the
+working CVS checkout, import those changes into your local CVS
+checkout, create a temporary CVS checkout to merge your local
+changes, fix any conflicts, commit your changes, and then update
+your site. It sounds complicated, but it's not too bad, and it
+is the best way to work around CVS's limitations.
      This part describes how to set up your working CVS checkout.
 Once it is set up, you'll be able to update any packages using
 the existing working CVS checkout. We use one dedicated directory
 for each branch of OpenACS - if you are using OpenACS 5.1,x, you
@@ -77,7 +80,8 @@
 latest compatible version of each package. Each minor release of
 OpenACS since 5.0 has this tagging structure. For example, OpenACS
 5.1.x has openacs-5-1-compat.
      You will want to separately check out all the packages you are
-using.
      [root root]# su - $OPENACS_SERVICE_NAME
+using.
      +[root root]# su - $OPENACS_SERVICE_NAME
 
 [$OPENACS_SERVICE_NAME aolserver]$ cd /var/lib/aolserver
 [$OPENACS_SERVICE_NAME aolserver]$ cvs -d :pserver:anonymous\@cvs.openacs.org:/cvsroot checkout -r openacs-5-1-compat acs-core
@@ -93,11 +97,13 @@
 tree. You might want to start over, remove your working CVS
 checkout, and try again.
      
 
    • 
-
      Step 1: Import new OpenACS code. 
        
+
        Step 1: Import new OpenACS
+code. 
          
 
        • 
 
          
-Update CVS. Update your local CVS working
-checkout (unless you just set it up).
          [root root]# su - $OPENACS_SERVICE_NAME
+Update CVS. Update your local CVS
+working checkout (unless you just set it up).
          +[root root]# su - $OPENACS_SERVICE_NAME
 
 [$OPENACS_SERVICE_NAME aolserver]$ cd /var/lib/aolserver/openacs-5-1
 
@@ -106,8 +112,9 @@
 
        • 
 
          
 Update a single package via cvs working
-checkout. You can add or upgrade a single package at
-a time, if you already have a cvs working directory.
          [root root]# su - $OPENACS_SERVICE_NAME
+checkout. You can add or upgrade a single
+package at a time, if you already have a cvs working directory.
          +[root root]# su - $OPENACS_SERVICE_NAME
 
 [$OPENACS_SERVICE_NAME aolserver]$ cd /var/lib/aolserver/packages/openacs-5-1
 
@@ -119,19 +126,21 @@
 
        
 
      • 
 
        
-Step 2: Merge New OpenACS code. Now that
-you have a local copy of the new OpenACS code, you need to import
-it into your local CVS repository and resolve any conflicts that
-occur.
        Import the new files into your cvs repository; where they match
-existing files, they will become the new version of the file.
        [$OPENACS_SERVICE_NAME openacs-5-1]$  cd /var/lib/aolserver/openacs-5-1
+Step 2: Merge New OpenACS code. Now
+that you have a local copy of the new OpenACS code, you need to
+import it into your local CVS repository and resolve any conflicts
+that occur.
        Import the new files into your cvs repository; where they match
+existing files, they will become the new version of the file.
        +[$OPENACS_SERVICE_NAME openacs-5-1]$  cd /var/lib/aolserver/openacs-5-1
 
 [$OPENACS_SERVICE_NAME openacs-5-1]$  cvs -d /var/lib/cvs import -m "upgrade to OpenACS 5.1" $OPENACS_SERVICE_NAME OpenACS openacs-5-1
 
 
        
 
        Tip
        If adding or upgrading a single package, run the cvs import from
 within the base directory of that package, and adjust the cvs
 command accordingly. In this example, we are adding the
-myfirstpackage package.
        [root root]# su - $OPENACS_SERVICE_NAME
+myfirstpackage package.
        +[root root]# su - $OPENACS_SERVICE_NAME
 
 [$OPENACS_SERVICE_NAME aolserver]$ cd /var/lib/aolserver/openacs-5-0/package/myfirstpackage
 
@@ -142,11 +151,13 @@
 uses the cvs keyword yesterday, making the assumption that you
 haven't checked in new code to your local tree in the last day.
 This section should be improved to use tags instead of the keyword
-yesterday!
        [$OPENACS_SERVICE_NAME openacs-5.1]$  cd /var/lib/aolserver
+yesterday!
        +[$OPENACS_SERVICE_NAME openacs-5.1]$  cd /var/lib/aolserver
 [$OPENACS_SERVICE_NAME tmp]$ rm -rf $OPENACS_SERVICE_NAME-upgrade
 [$OPENACS_SERVICE_NAME tmp]$ mkdir $OPENACS_SERVICE_NAME-upgrade
 [$OPENACS_SERVICE_NAME tmp]$ cvs checkout -d $OPENACS_SERVICE_NAME-upgrade -jOpenACS:yesterday -jOpenACS -kk $OPENACS_SERVICE_NAME > cvs.txt 2>&1
-(CVS feedback here)
        The file /var/tmp/openacs-upgrade/cvs.txt contains the results
+(CVS feedback here)
+
        The file /var/tmp/openacs-upgrade/cvs.txt contains the results
 of the upgrade. If you changed files that are part of the OpenACS
 tarball and those changes conflict, you'll have to manually
 reconcile them. Use the emacs command M-x sort-lines (you may have to click
@@ -155,32 +166,37 @@
 C, open that file and manually resolve the conflict by deleting the
 excess lines. When you're finished, or if there aren't any
 conflicts, save and exit.
        Once you've fixed any conflicts, commit the new code to your
-local tree.
        [$OPENACS_SERVICE_NAME tmp]$ cd $OPENACS_SERVICE_NAME-upgrade
+local tree.
        +[$OPENACS_SERVICE_NAME tmp]$ cd $OPENACS_SERVICE_NAME-upgrade
 [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME-upgrade]$ cvs commit -m "Upgraded to 5.1"
 
        
 
      • 
 
        
 Step 3: Upgrade your local staging
-site. Update your working tree with the new files.
-The CVS flags ensure that new directories are created and pruned
-directories destroyed.
        [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME-upgrade]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME
+site. Update your working tree with the new
+files. The CVS flags ensure that new directories are created and
+pruned directories destroyed.
        +[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME-upgrade]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME
 
 [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ cvs up -Pd
 (CVS feedback)
 [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ exit
-[root root]# 
        
+[root root]# 
+
        
 
        • 
 
      
 
      • 
 
    Upgrading files for a site using
-the OpenACS CVS repository (cvs.openacs.org)
    1. [$OPENACS_SERVICE_NAME ~]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME
+the OpenACS CVS repository (cvs.openacs.org)
      1. +[$OPENACS_SERVICE_NAME ~]$ cd /var/lib/aolserver/$OPENACS_SERVICE_NAME
 
 [$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$ cvs up -Pd
 (CVS feedback)
-[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
      
+[$OPENACS_SERVICE_NAME $OPENACS_SERVICE_NAME]$
+

-Upgrading a Production Site Safely

If you are upgrading a production OpenACS site which is on a +Upgrading a Production Site Safely

If you are upgrading a production OpenACS site which is on a private CVS tree, this process lets you do the upgrade without risking extended downtime or an unusable site:

  1. Declare a freeze on new cvs updates - ie, you cannot run cvs