aboutsummaryrefslogtreecommitdiff
path: root/docs/en/admins/07_LinuxUpdate.md
diff options
context:
space:
mode:
authorGravatar Marien Fressinaud <dev@marienfressinaud.fr> 2019-12-15 14:08:49 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2019-12-15 14:08:49 +0100
commit82851d2039f619f1b2558e06b04a9e47fceeea54 (patch)
treeab3142289e260111c686e740b9f4214453a0a84c /docs/en/admins/07_LinuxUpdate.md
parent0765840d9d0998bd09a2cf7c4fe97785c791fc9b (diff)
Make master the rolling release branch (#2705)
* Change default TAG in Makefile We are going to drop the `dev` branch. The Docker tag `dev-*` are based on this branch and so there will be no longer be generated. We must use images based on the `master` branch (i.e. `latest`, `alpine` and `arm`). * Remove references to dev branch in documentation * Synchronize French documentation
Diffstat (limited to 'docs/en/admins/07_LinuxUpdate.md')
-rw-r--r--docs/en/admins/07_LinuxUpdate.md64
1 files changed, 28 insertions, 36 deletions
diff --git a/docs/en/admins/07_LinuxUpdate.md b/docs/en/admins/07_LinuxUpdate.md
index 7bd867639..c14e07517 100644
--- a/docs/en/admins/07_LinuxUpdate.md
+++ b/docs/en/admins/07_LinuxUpdate.md
@@ -1,7 +1,9 @@
-# Updating on Debian 9/Ubuntu 16.04
+# Updating on Linux
This tutorial demonstrates commands for updating FreshRSS. It assumes that your main FreshRSS directory is `/usr/share/FreshRSS`; If you've installed it somewhere else, substitute your path as necessary.
+**Note that FreshRSS contains a built-in update system.** It's easier to use if you don't understand the commands that follow. It's available through the web interface of your FreshRSS installation, Administration → Update.
+
## Using git
**You must have used git to install FreshRSS to use this update method.**
@@ -13,58 +15,46 @@ If your local user doesn't have write access to the FreshRSS folder, use a sudo
cd /usr/share/FreshRSS/
```
-2. Verify the branch you're currently on. For stable releases, this should be `master`.
+2. Fetch the most recent code from GitHub
```
-git branch
+git fetch --all
```
-
-3. Fetch the most recent code from the FreshRSS github Page
+3. Discard manual changes and delete manual additions
```
-git fetch --all
+git reset --hard
+git clean -f -d
```
-Note: If you wish to switch to a specific version of FreshRSS, or switch to/from the dev branch, this is the time to do that. Example commands for switching branches are found below, in "Switching Branches"
+Note: If you wish to keep your changes, it's better to [create a pull request](https://github.com/FreshRSS/FreshRSS/compare) or [an extension](../developers/03_Backend/05_Extensions.md).
-4. Check for an update
+4. Update FreshRSS
```
-git status
+git checkout master
+git pull
+git checkout $(git describe --tags --abbrev=0)
```
-If there's not an update, you're done! If there is, continue the following steps:
+Note: If you want to use the rolling release, the last command is optional.
-5. Discard manual changes and delete manual additions
+5. (optional) Make sure you use the correct version
```
-git reset --hard
-git clean -f -d
+git status
```
+The command should tell you the tag that you're using. It must be the same as the one associated with [the latest release on GitHub](https://github.com/FreshRSS/FreshRSS/releases/latest). If you use the rolling release, it should tell you that your `master` branch is up to date with `origin`.
+
6. Delete the file that triggers the install wizard
```
rm data/do-install.txt
```
-7. Update to the new version of FreshRSS
-```
-git pull
-```
-
-8. Re-set correct permissions so that your web server can access the files
+7. Re-set correct permissions so that your web server can access the files
```
chown -R :www-data . && chmod -R g+r . && chmod -R g+w ./data/
```
-### Switching Branches
-
-Any command listed here should be run between steps 3 and 4 in the previous section.
-
-To switch from stable to dev (if you haven't before) use the following command: `git checkout -b dev origin/dev`
-
-If you've checked out dev and want to go back to master, the command would be `git checkout master`. After the first time you check out the dev branch, you can use this syntax to switch between the two main branches at will.
-
-If you wish to switch to [a specific release of FreshRSS](https://github.com/FreshRSS/FreshRSS/releases), you would use the command `git checkout <release_name>`, where <release_name> is the specific release number you wish to check out (for example, `git checkout 1.12.0`). Be aware that checking out a specific release will leave you in a state where you can't automatically update; you'll need to run `git checkout master` or `git checkout dev` before you'll be able to pull updates from git automatically.
-
-## Using the zip Archive
+## Using the Zip archive
If your local user doesn't have write access to the FreshRSS folder, use a sudo shell (`sudo -s`), prefix the following commands with `sudo `, or switch to an account that does have write access to the folder.
@@ -73,15 +63,17 @@ If your local user doesn't have write access to the FreshRSS folder, use a sudo
cd /usr/share/FreshRSS/
```
-2. Download and unzip the update file
+2. Get the link to the Zip archive for [the latest release](https://github.com/FreshRSS/FreshRSS/releases/latest). It should be something like `https://github.com/FreshRSS/FreshRSS/archive/1.15.3.zip` (the numbers can change). If you want to use the rolling release, the link is `https://github.com/FreshRSS/FreshRSS/archive/master.zip`
+
+3. Download and unzip the update file
```
-wget https://github.com/FreshRSS/FreshRSS/archive/master.zip
-unzip master.zip
+wget -o freshrss.zip https://github.com/FreshRSS/FreshRSS/archive/1.15.3.zip
+unzip freshrss.zip
```
3. Overwrite all your existing files with the new ones
```
-cp -R FreshRSS-master/* .
+cp -R FreshRSS-*/* .
```
4. Re-set permissions
@@ -91,7 +83,7 @@ chown -R :www-data . && chmod -R g+r . && chmod -R g+w ./data/
5. Clean up the FreshRSS directory by deleting the downloaded zip, the file forcing the setup wizard and the temporary directory
```
-rm -f master.zip
+rm -f freshrss.zip
rm -f data/do-install.txt
-rm -rf FreshRSS-master/
+rm -rf FreshRSS-*/
```