Skip to content

Commit

Permalink
More docs around upgrades
Browse files Browse the repository at this point in the history
  • Loading branch information
kgilmer committed Apr 5, 2020
1 parent f2493a6 commit 6dfcfbb
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
16 changes: 14 additions & 2 deletions content/en/docs/Getting started/install.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Based on your preferred installation method, follow one of the following two sec
## Option 1: Ubuntu Installer

{{% pageinfo %}}
ISO installers are not yet available for the R1.3.1 release. Until available, the R1.3 release can be installed and updates will bring the system up to R1.3.1 automatically.
ISO installers are not available for the R1.3.1 release. The R1.3 release can be installed and updates will bring the system up to R1.3.1 automatically.
{{% /pageinfo %}}

1. Download an [ISO image <i class="fas fa-cloud-download-alt"></i>](https://sourceforge.net/projects/regolith-linux/files/regolith-linux-r1.3/) (both the Ubuntu LTS 18.04 and most recent 19.10 bases are available) and then use an OS installation tool such as USB Creator to write the downloaded file into a USB device. Here are Ubuntu guides for performing this action in [Windows](https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-windows#0), [Mac](https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-macos#0), and [Ubuntu](https://tutorials.ubuntu.com/tutorial/tutorial-create-a-usb-stick-on-ubuntu#0).
Expand All @@ -35,7 +35,17 @@ $ sudo apt install regolith-desktop

## Upgrades

When updating from a major or minor version (eg 1.2 to 1.3), it is often the case that new Xresource values and other config files have been updated. Existing Xresource and config files such as the i3 config file will need to be updated in order for the upgrade to function properly. If you've customized any Regolith config files or created a stand-alone Xresource file (`~/.Xresources-regolith`), these will need to be updated to take the upgraded files into account. A simple approach to doing this is to move them elsewhere, perform the upgrade, and then reintegrate any desired customizations into the new files:
To upgrade from Regolith 1.0 - 1.2, the PPA URL must be changed and then new package versions are applied by the package manager:
```bash
$ sudo add-apt-repository --remove ppa:kgilmer/regolith-stable
$ sudo add-apt-repository ppa:regolith-linux/release
$ sudo apt update && sudo apt dist-upgrade
```
After performing these steps, you'll need to log out and back again.

### Upgrading with Customizations

When updating from a major or minor version (eg 1.2 to 1.3), it is often the case that new Xresource values and other config files have been updated. Existing Xresource and config files such as the i3 config file will need to be updated in order for the upgrade to function properly. If you've customized any Regolith config files or created a stand-alone Xresource file (`~/.Xresources-regolith`), these may need to be updated to take the upgraded files into account. A simple approach to doing this is to move them elsewhere, perform the upgrade, and then reintegrate any desired customizations into the new files:

```bash
$ mkdir ~/regolith-backup
Expand All @@ -44,6 +54,8 @@ $ cp -r ~/.config/regolith/i3* ~/regolith-backup
$ rm -Rf ~/.config/regolith/flags
```

Once these steps are performed, logging back in should result in a "stock" instance of Regolith. From there, any changes desired to be reintegrated can be done by editing the new versions of the Regolith config files that exist in the `/etc/regolith` directory.

### Edits to `root`-owned files

If you've taken shortcuts and manually edited files owned by `root` in `/etc/regolith` or elsewhere, the packaging tool may not update the files, nor mention that stale files have been left. Even removing the package via `apt remove ...` may not result in a clean system. In this case, use the purge command to remove the package and manually delete any left over files. For example, to clean up the i3 config file:
Expand Down

0 comments on commit 6dfcfbb

Please sign in to comment.