Revision: 844
http://svn.savannah.gnu.org/viewvc/?view=rev&root=administration&revision=844
Author: ineiev
Date: 2025-07-30 11:24:50 -0400 (Wed, 30 Jul 2025)
Log Message:
-----------
clarify on Savane installation update procedure
Explain why not make local changes in the installed files.
Add more links to SavaneSetup.
Minor updates and improvements.
Modified Paths:
--------------
trunk/sviki/FrontEndSetup.mdwn
trunk/sviki/SavaneReleases.mdwn
trunk/sviki/SavaneSetup.mdwn
trunk/sviki/back-page.mdwn
Modified: trunk/sviki/FrontEndSetup.mdwn
===================================================================
--- trunk/sviki/FrontEndSetup.mdwn 2025-07-22 16:51:20 UTC (rev 843)
+++ trunk/sviki/FrontEndSetup.mdwn 2025-07-30 15:24:50 UTC (rev 844)
@@ -11,6 +11,7 @@
* [[SavannahServices]] - services/daemons available on Savannah hosts.
* [[SavannahInternals]] - Savannah inner-workings.
* [[SavannahHosts]] - Configuration of the new servers.
+* [[SavaneSetup]] - Updating Savane installation.
Further reading about Savannah web frontend:
@@ -42,8 +43,8 @@
## "Site-specific" files
-Several sections of the displayed HTML
-on the Savannah website are taken from files in frontend/site-specific/.
+Several sections of the displayed HTML on the Savannah website
+are taken from files in frontend/site-specific/ of the source tree of Savane.
Savannah license list offered when registering new groups is also stored
in one of those files.
Modified: trunk/sviki/SavaneReleases.mdwn
===================================================================
--- trunk/sviki/SavaneReleases.mdwn 2025-07-22 16:51:20 UTC (rev 843)
+++ trunk/sviki/SavaneReleases.mdwn 2025-07-30 15:24:50 UTC (rev 844)
@@ -12,7 +12,7 @@
In the same area, we may also release auxiliary files like dumps of sample
Savane database.
-## Working branches
+##<a id="branches"></a> Working branches
[Our Savane
repository](//git.savannah.gnu.org/cgit/administration/savane.git)
@@ -39,13 +39,15 @@
to the respective commit at our Cgit instance is provided. Keeping the
frontend
branch at the specific commit makes sure that it is accessible and git gc
doesn't
remove it.
-- The sv_membersh script for SSH access, as of 2024-04 used at the download
+- The sv_membersh script for SSH access, as of 2025-07 used at the download
server. The source code of Savane is provided from the same machine through
RSYNC, which is one of the protocols offered for downloading the hosted data.
+See [[Savane upgrade workflow|SavaneSetup]].
+
---
-Copyright © 2024 Ineiev
+Copyright © 2024, 2025 Ineiev
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
Modified: trunk/sviki/SavaneSetup.mdwn
===================================================================
--- trunk/sviki/SavaneSetup.mdwn 2025-07-22 16:51:20 UTC (rev 843)
+++ trunk/sviki/SavaneSetup.mdwn 2025-07-30 15:24:50 UTC (rev 844)
@@ -1,6 +1,6 @@
# Savane setup
-As of 2024-09, Savane is installed and runs on mgt1, download0,
+As of 2025-07, Savane is installed and runs on mgt1, download0,
vcs0, vcs1, vcs2, frontend2. The installation procedure
is quite uniform.
@@ -7,14 +7,30 @@
The bootstrapped Git repository is located at /opt/src/savane;
the package is built in /root/build-savane/build.
/root/build-savane has a link savane-bootstrapped pointing at
-/opt/src/savane.
+/opt/src/savane. Using a checkout of the official repository
+(as opposed to directly editing the files at the location
+where they are installed) is important for a few reasons,
+* When the changes are pushed to the Savane repository first,
+ the next admin who updates has a chance to see them. The
+ local-only changes may go unnoticed and be rewritten.
+* Even if the changes are overwritten, they can be restored
+ when we have them in the Savane repository. The local-only
+ changes will be lost and can only be restored from human
+ memory.
+* Savane is licensed under the AGPL, and that requires offering
+ the *corresponding* source code. Savane design ensures that
+ the offered code is corresponding when installed with the
+ regular workflow. In cases like frontend, making arbitrary
+ changes in installed files violates the license.
+
The configuration is maintained in /etc/savane: either Savane is
configured with `--sysconfdir=/etc`, or /opt/savane/etc/savane
contain links to the files from /etc/savane.
Basic steps to update Savane after logging in as root
-the machine in question are:
+the machine in question are (replace `frontend` in `origin/frontend` with
+the name of [[another branch|SavaneReleases#branches]] if needed):
- cd ~/build-savane/savane-bootstrapped; git fetch origin
- git diff --color=always HEAD origin/frontend
@@ -34,8 +50,8 @@
rm -fr /opt/savane~
cp -a /opt/savane{,~}
-- Update configuration files in /etc/savane. 'make install' keeps
- the existing configuration files unchanged.
+- Update configuration files in /etc/savane. 'make install' is designed
+ to keep the existing configuration files unchanged.
## Common settings
@@ -57,7 +73,7 @@
The offer from sv_membersh suggests an rsync option that omits the '.git'
directory, so a ChangeLog is generated from Git logs as a way to list
-the changes made in original software. (As of 2024-09, sv_membersh isn't
+the changes made in original software. (As of 2025-07, sv_membersh isn't
used on vcs machines, but that doesn't invalidate the Savane setup above
and the possibility to get the corresponding source code of the running
instance.)
@@ -69,7 +85,7 @@
---
-Copyright © 2024 Ineiev
+Copyright © 2024, 2025 Ineiev
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
Modified: trunk/sviki/back-page.mdwn
===================================================================
--- trunk/sviki/back-page.mdwn 2025-07-22 16:51:20 UTC (rev 843)
+++ trunk/sviki/back-page.mdwn 2025-07-30 15:24:50 UTC (rev 844)
@@ -188,7 +188,7 @@
- [[Tips on communications|CodeOfConduct]]
- [[How Savannah data are archived|Backup]]
- [[A few words about our database schema|SavannahDatabaseSchema]]
-- [[How Savane is updated|SavaneSetup]]
+- [[How Savane installation is updated|SavaneSetup]]
### Download
@@ -307,7 +307,7 @@
---
-Copyright © 2023, 2024 Ineiev
+Copyright © 2023, 2024, 2025 Ineiev
Copying and distribution of this file, with or without modification,
are permitted in any medium without royalty provided the copyright
