Browse Source

Update the update docs (#66)

* Update the update docs

* Explicitely say that prebuit binaries are for 64 bits Linux.
dev
Ana Gelez 3 years ago
committed by GitHub
parent
commit
0ae09480c6
No known key found for this signature in database GPG Key ID: 4AEE18F83AFDEB23
  1. 78
      Gemfile.lock
  2. 26
      source/update.html.md
  3. 22
      source/update/docker.html.md
  4. 18
      source/update/index.html.md
  5. 44
      source/update/prebuilt.html.md
  6. 31
      source/update/source-code.html.md
  7. 7
      source/update/yunohost.html.md

78
Gemfile.lock

@ -1,60 +1,57 @@
GEM
remote: https://rubygems.org/
specs:
activesupport (5.0.7.1)
activesupport (5.0.7.2)
concurrent-ruby (~> 1.0, >= 1.0.2)
i18n (>= 0.7, < 2)
minitest (~> 5.1)
tzinfo (~> 1.1)
addressable (2.5.2)
public_suffix (>= 2.0.2, < 4.0)
autoprefixer-rails (8.6.5)
addressable (2.7.0)
public_suffix (>= 2.0.2, < 5.0)
autoprefixer-rails (9.7.0)
execjs
backports (3.11.4)
backports (3.15.0)
coffee-script (2.4.1)
coffee-script-source
execjs
coffee-script-source (1.12.2)
compass-import-once (1.0.5)
sass (>= 3.2, < 3.5)
concurrent-ruby (1.1.3)
concurrent-ruby (1.1.5)
contracts (0.13.0)
dotenv (2.5.0)
dotenv (2.7.5)
erubis (2.7.0)
execjs (2.7.0)
fast_blank (1.0.0)
fastimage (2.1.5)
ffi (1.9.25)
haml (5.0.4)
fastimage (2.1.7)
ffi (1.11.1)
haml (5.1.2)
temple (>= 0.8.0)
tilt
hamster (3.0.0)
concurrent-ruby (~> 1.0)
hashie (3.6.0)
i18n (0.7.0)
i18n (0.9.5)
concurrent-ruby (~> 1.0)
kramdown (1.17.0)
listen (3.0.8)
rb-fsevent (~> 0.9, >= 0.9.4)
rb-inotify (~> 0.9, >= 0.9.7)
memoist (0.16.0)
middleman (4.2.1)
middleman (4.3.5)
coffee-script (~> 2.2)
compass-import-once (= 1.0.5)
haml (>= 4.0.5)
kramdown (~> 1.2)
middleman-cli (= 4.2.1)
middleman-core (= 4.2.1)
sass (>= 3.4.0, < 4.0)
middleman-autoprefixer (2.9.0)
autoprefixer-rails (~> 8.0)
middleman-cli (= 4.3.5)
middleman-core (= 4.3.5)
middleman-autoprefixer (2.10.1)
autoprefixer-rails (~> 9.1)
middleman-core (>= 3.3.3)
middleman-cli (4.2.1)
middleman-cli (4.3.5)
thor (>= 0.17.0, < 2.0)
middleman-core (4.2.1)
middleman-core (4.3.5)
activesupport (>= 4.2, < 5.1)
addressable (~> 2.3)
backports (~> 3.6)
bundler (~> 1.1)
bundler
contracts (~> 0.13.0)
dotenv
erubis
@ -63,40 +60,41 @@ GEM
fastimage (~> 2.0)
hamster (~> 3.0)
hashie (~> 3.4)
i18n (~> 0.7.0)
i18n (~> 0.9.0)
listen (~> 3.0.0)
memoist (~> 0.14)
padrino-helpers (~> 0.13.0)
parallel
rack (>= 1.4.5, < 3)
sass (>= 3.4)
sassc (~> 2.0)
servolux
tilt (~> 2.0)
tilt (~> 2.0.9)
uglifier (~> 3.0)
middleman-syntax (3.0.0)
middleman-syntax (3.2.0)
middleman-core (>= 3.2)
rouge (~> 2.0)
minitest (5.11.3)
rouge (~> 3.2)
minitest (5.13.0)
padrino-helpers (0.13.3.4)
i18n (~> 0.6, >= 0.6.7)
padrino-support (= 0.13.3.4)
tilt (>= 1.4.1, < 3)
padrino-support (0.13.3.4)
activesupport (>= 3.1)
parallel (1.12.1)
public_suffix (3.0.3)
rack (2.0.6)
parallel (1.18.0)
public_suffix (4.0.1)
rack (2.0.7)
rb-fsevent (0.10.3)
rb-inotify (0.9.10)
ffi (>= 0.5.0, < 2)
redcarpet (3.4.0)
rouge (2.2.1)
sass (3.4.25)
rb-inotify (0.10.0)
ffi (~> 1.0)
redcarpet (3.5.0)
rouge (3.12.0)
sassc (2.2.1)
ffi (~> 1.9)
servolux (0.13.0)
temple (0.8.0)
temple (0.8.2)
thor (0.20.3)
thread_safe (0.3.6)
tilt (2.0.9)
tilt (2.0.10)
tzinfo (1.2.5)
thread_safe (~> 0.1)
uglifier (3.2.0)
@ -114,4 +112,4 @@ DEPENDENCIES
wdm (~> 0.1)
BUNDLED WITH
1.17.1
2.1.0.pre.1

26
source/update.html.md

@ -1,26 +0,0 @@
---
title: Updating your instance
icon: arrow-up
summary: 'Plume is still unstable and regularly gets new features and bug fixes. Keeping your
instance up-to-date is important.'
---
To update your instance, run these commands with `plume` user if you created it, or with your default user, in the Plume directory.
Replace DATABASE with either postgres or sqlite depending on what you want to use.
```bash
git pull origin master
cargo web deploy -p plume-front
cargo install --force --no-default-features --features DATABASE && cargo install --path plume-cli --force --features DATABASE
# Run the migrations
plm migration run
# If you are using sysvinit
sudo service plume restart
# If you are using systemd
sudo systemctl restart plume
```
That's it!

22
source/update/docker.html.md

@ -0,0 +1,22 @@
---
title: Updating with Docker
---
To update your dockerized Plume instance, replace the version tag with `v0.4.0` in your `docker-compose.yml`
Then, run:
```bash
# Grab the latest images
docker-compose pull
# Stop your instance
docker-compose down
# Run migrations
docker-compose run --rm plume plm migration run
# Restart your instance
docker-compose up -d
```
And you are done!

18
source/update/index.html.md

@ -0,0 +1,18 @@
---
title: Updating your instance
icon: arrow-up
summary: 'Plume is still unstable and regularly gets new features and bug fixes. Keeping your
instance up-to-date is important.'
---
The instructions to update your instance depends on your installation method.
Please choose the one you are using:
<ul class="choices">
<li><a href="/update/docker">Docker</a></li>
<li><a href="/update/yunohost">YunoHost</a></li>
<li><a href="/update/prebuilt">Prebuilt binaries</a></li>
<li><a href="/update/source-code">From source</a></li>
</ul>
Also please check [the release notes](https://github.com/Plume-org/Plume/releases) to see if any additional operation is needed.

44
source/update/prebuilt.html.md

@ -0,0 +1,44 @@
---
title: Updating pre-built binaries
---
Prebuilt binaries are only available for 64 bits Linux machines.
You'll need to define these two variables in your shell first:
- `PLUME_VERSION`: the Plume version to install. The latest is `0.4.0-alpha-4`.
- `PLUME_DB`: the database backend to use. Either `postgres` or `sqlite`.
Then run these commands:
```bash
# Go Plume's directory
cd Plume
# Download the files
wget -O plume.tar.gz https://github.com/Plume-org/Plume/releases/download/$PLUME_VERSION/plume-$PLUME_DB.tar.gz
# Extract them
tar -xf plume.tar.gz
mv bin/* ~/.cargo/bin/
# Make sure they are executable
chmod +x ~/.cargo/bin/*
# Clean useless files
rm plume.tar.gz
rmdir bin
# Run migrations
plm migration run
```
To check that everything went well, you can run `plume --version`, which should show the new version number.
You can now restart your instance:
```bash
# If you are using sysvinit
sudo service plume restart
# If you are using systemd
sudo systemctl restart plume
```

31
source/update/source-code.html.md

@ -0,0 +1,31 @@
---
title: Updating from source
---
To update your instance, run these commands with `plume` user if you created it, or with your default user, in the Plume directory.
Replace `DATABASE` with either postgres or sqlite depending on what you are using, and `PLUME_VERSION` with the latest version tag (`0.4.0-alpha-4` currently).
```bash
# Get the latest version of the code
git pull origin master
git checkout PLUME_VERSION # Skip this step if you want to use master, and not a tagged release
# Build the front-end
cargo web deploy -p plume-front
# Update plm
cargo install --path plume-cli --force --features DATABASE
# Update plume
cargo install --path . --force --no-default-features --features DATABASE
# Run the migrations
plm migration run
# Restart your instance
# If you are using sysvinit
sudo service plume restart
# If you are using systemd
sudo systemctl restart plume
```
That's it!

7
source/update/yunohost.html.md

@ -0,0 +1,7 @@
---
title: Updating with YunoHost
---
You can either use YunoHost's graphical interface or their command line tools to update.
See the [official documentation](https://yunohost.org/#/app_update_fr) for detailed instructions.
Loading…
Cancel
Save