Update the update docs (#66)
* Update the update docs * Explicitely say that prebuit binaries are for 64 bits Linux.pull/69/head
parent
6a5f7dd922
commit
0ae09480c6
@ -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!
|
@ -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!
|
@ -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.
|
@ -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
|
||||
```
|
@ -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!
|
@ -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…
Reference in New Issue