Enable systemd-homed
[workstation-ostree-config.git] / README.md
index 136f14ec2dce434cb81b25742620c781411cec14..b0eb74d811dfd62a354266c36f1347c73f20b3ea 100644 (file)
--- a/README.md
+++ b/README.md
@@ -1,3 +1,30 @@
+Martin Pitt's desktop
+=====================
+
+This is an [rpm-ostree](https://coreos.github.io/rpm-ostree/) based minimal
+[Fedora](https://getfedora.org/) developer desktop with the [sway window manager](https://swaywm.org/) and [podman](https://podman.io/)/[toolbox](https://docs.fedoraproject.org/en-US/fedora-silverblue/toolbox/) for doing development and running less common graphical applications.
+
+It gets [automatically built](.github/workflows/build.yml) every week and [published to my server](https://piware.de/ostree/pitti-workstation/).
+
+To use it from an existing OSTree based system like [Fedora CoreOS](https://getfedora.org/coreos) or [Fedora Silverblue](https://docs.fedoraproject.org/en-US/fedora-silverblue/), add my server URL as new remote and rebase your tree to it:
+
+```sh
+sudo ostree remote add --no-gpg-verify piware https://piware.de/ostree/pitti-workstation/
+sudo rpm-ostree rebase piware:pitti-desktop
+```
+
+After that, you can install weekly updates with
+
+```
+sudo rpm-ostree upgrade
+```
+
+If anything goes wrong, you can go back to the previous version with `sudo rpm-ostree rollback`.
+
+
+Original README for [workstation-ostree-config](https://pagure.io/workstation-ostree-config)
+=============================================
+
 For some background, see:
 
  - https://fedoraproject.org/wiki/Workstation/AtomicWorkstation
@@ -20,40 +47,36 @@ This project is actively maintained and is ready for use
 by sophisticated and interested users, but not ready
 for widespread promotion.
 
-Installing
-----------
+See some [https://lists.fedoraproject.org/archives/list/desktop@lists.fedoraproject.org/thread/J6BJS7Z4NKNOQUZWGYXZZIEKYMWBBSUY/](discussion about the first release).
 
-Important!  Don't choose auto-partitioning in the below installer ISO.  You
-need to change `/home` to be `/var/home`.  A bit more information in
-this [known issue](https://github.com/rhinstaller/anaconda/issues/800).
+Installing
+------------
 
-There are ISOs available for [Fedora 26](https://kojipkgs.fedoraproject.org/compose//branched/)
-and [rawhide](https://kojipkgs.fedoraproject.org/compose//rawhide/).
+See the Silverblue documentation at
+https://docs.fedoraproject.org/en-US/fedora-silverblue/installation-guide/.
+There's also a guide for installing inside an existing system:
+https://docs.fedoraproject.org/en-US/fedora-silverblue/installation-dual-boot/.
 
 Important issues:
 -----------------------
 
- - [Anaconda autopartitoning](https://github.com/rhinstaller/anaconda/issues/800) - be sure to use `/var/home` instead of `/home`
  - [flatpak system repo](https://github.com/flatpak/flatpak/issues/113#issuecomment-247022006)
-Migrating between OSTree repos
--------------------------------------
 
-Enable the 26/27 remotes:
-```
-ostree remote add --if-not-exists --gpg-import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-26-primary fedora-ws-26 https://kojipkgs.fedoraproject.org/compose/ostree/26
-ostree remote add --if-not-exists --gpg-import /etc/pki/rpm-gpg/RPM-GPG-KEY-fedora-27-primary fedora-ws-27 https://kojipkgs.fedoraproject.org/compose/ostree/rawhide
-```
-Rebase to rawhide:
-```
-rpm-ostree rebase fedora-ws-27:fedora/rawhide/x86_64/workstation
-```
 Using the system
 --------------------
 
-First, try out `rpm-ostree install` to layer additional packages.  For example,
-`rpm-ostree install powerline`.
+One of the first things you should do use is use a container runtime of your
+choice to manage one or more "pet" containers.  This is where you will use
+`yum/dnf` to install utilities.
+
+With `docker` for example, you can use the `-v /srv:/srv` command line option so
+these containers can share content with your host (such as git repositories).
+Note that if you want to share content between multiple Docker containers and
+the host (e.g. your desktop session), you should execute (once):
+
+```
+sudo chcon -R -h -t container_file_t /var/srv
+```
 
 Next, let's try flatpak. Before you do: There's a known flatpak issue on
 AtomicWS - run [this workaround](https://github.com/flatpak/flatpak/issues/113#issuecomment-247022006),
@@ -63,15 +86,12 @@ If you are a developer for server applications,
 try [oc cluster up](https://github.com/openshift/origin/blob/master/docs/cluster_up_down.md) to
 create a local OpenShift v3 cluster.
 
-Finally, you'll likely want to make one or more "pet" Docker containers,
-potentially privileged, and use `dnf/yum` inside these. You can use e.g. `-v
-/srv:/srv` so these containers can share content with your host (such as git
-repositories). Note that if you want to share content between multiple Docker
-containers and the host (e.g. your desktop session), you should execute (once):
-
-```
-sudo chcon -R -h -t container_file_t /var/srv
-```
+Finally, try out `rpm-ostree install` to layer additional packages directly on
+the host. This is needed for "host extensions" - privileged software that
+doesn't make sense to live in a container. For example, `rpm-ostree install
+powerline` to use that software for the shell prompts of the host.  Another
+good example is `rpm-ostree install vagrant-libvirt` to use [Vagrant](https://www.vagrantup.com/)
+to manage VMs.
 
 Future work
 -----------