Minimally document snap package #68

Merged
RAOF merged 2 commits from plume/documentation:document-snap into dev 2019-12-02 09:47:00 +00:00
2 changed files with 30 additions and 0 deletions

View file

@ -10,6 +10,7 @@ in this list:
<ul class="choices">
<li><a href="with/docker">Docker</a></li>
<li><a href="with/snap">Snap</a></li>
<li><a href="with/yunohost">YunoHost</a></li>
<li><a href="with/prebuilt">Prebuilt binaries</a></li>
<li><a href="deps">From source</a></li>

View file

@ -0,0 +1,29 @@
---
title: Installing from the Snap store
---
Plume is available on the [Snap Store](https://snapcraft.io/plume).
The snap package is isolated from your host and will automatically update, running any necessary migration
tasks.
igalic commented 2019-11-16 08:21:42 +00:00 (Migrated from github.com)
Review

one sentence per line, please
also, an example of how to install from command line would be appreciated

one sentence per line, please also, an example of how to install from command line would be appreciated
RAOF commented 2019-11-30 06:49:16 +00:00 (Migrated from github.com)
Review

How's this?

How's this?
If you already have `snapd` installed, you can install Plume with `sudo snap install --edge plume`.
More information, including instructions for installing `snapd` on your distro, can be found
on Plume's entry on the [Snap Store](https://snapcraft.io/plume).
### Configuring the Plume snap
The Plume snap uses the native snap configuration interfaces to handle setup.
The minimal set up is `sudo snap set plume db.type=sqlite base-url=example.com`
followed by `sudo snap set plume enabled=true`.
This sets the base snap configuration; now you must configure your instance:
`sudo plume.plm instance new -d 'domain.name' -n 'instance name' -l 'default licence'`
`sudo plume.plm users new -n 'admin' -N 'name' -b 'bio' -e 'admin@domain.name' -p 'pass' --admin`
`sudo plume.plm search init`
And that's it! You can now setup a reverse-proxy to access Plume from other machines
than your server (which is probably what you want 😁).
<a class="action" href="/installation/proxy">Configure a reverse-proxy</a>