Documentation proofing

This commit is contained in:
Armando Lüscher
2019-05-19 11:38:09 +02:00
committed by Thomas Citharel
parent f3ff8c5b1e
commit 2821e5f12a
10 changed files with 92 additions and 91 deletions

View File

@@ -9,28 +9,28 @@
1. On a fresh Debian/Ubuntu, as root user, install basic utility programs needed for the installation
```
sudo apt-get install curl sudo unzip vim
sudo apt install curl sudo unzip vim
```
2. It would be wise to disable root access and to continue this tutorial with a user with sudoers group access
3. Install certbot (choose instructions for nginx and your distribution) :
3. Install certbot (choose instructions for nginx and your distribution):
[https://certbot.eff.org/all-instructions](https://certbot.eff.org/all-instructions)
4. Install NodeJS 10.x (current LTS):
[https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions](https://nodejs.org/en/download/package-manager/#debian-and-ubuntu-based-linux-distributions)
5. Install yarn, and be sure to have [a recent version](https://github.com/yarnpkg/yarn/releases/latest): [yarnpkg.com/en/docs/install#linux-tab](https://yarnpkg.com/en/docs/install#linux-tab)
5. Install Erlang and Elixir:
5. Install yarn, and be sure to have [a recent version](https://github.com/yarnpkg/yarn/releases/latest):
[https://yarnpkg.com/en/docs/install#linux-tab](https://yarnpkg.com/en/docs/install#linux-tab)
6. Install Erlang and Elixir:
[https://elixir-lang.org/install.html#unix-and-unix-like](https://elixir-lang.org/install.html#unix-and-unix-like)
6. Install PostGIS:
7. Install PostGIS:
[https://postgis.net/install/](https://postgis.net/install/)
6. Run:
8. Run:
```
sudo apt update
sudo apt install nginx postgresql postgresql-contrib openssl make git esl-erlang elixir postgis
```
Now that dependencies are installed, before running MobiliZon you should start PostgreSQL:
Now that dependencies are installed, before running Mobilizon you should start PostgreSQL:
```
sudo systemctl start postgresql
```
@@ -43,7 +43,7 @@ sudo systemctl start postgresql
sudo pacman -S nodejs postgresql openssl git wget unzip base-devel yarn nginx elixir postgis
```
Now that dependencies are installed, before running MobiliZon you should start PostgreSQL and Redis:
Now that dependencies are installed, before running Mobilizon you should start PostgreSQL and Redis:
```
sudo systemctl start postgresql
```

View File

@@ -13,7 +13,7 @@ sudo -u postgres createuser -P mobilizon
sudo -u postgres createdb -O mobilizon mobilizon_prod
```
Then enable extensions PeerTube needs:
Then enable extensions Mobilizon needs:
```bash
sudo -u postgres psql -c "CREATE EXTENSION postgis;" mobilizon_prod
@@ -22,7 +22,7 @@ sudo -u postgres psql -c "CREATE EXTENSION unaccent;" mobilizon_prod
```
## MobiliZon user
## Mobilizon user
Create a `mobilizon` user with `/home/mobilizon` home:
```bash
@@ -46,7 +46,7 @@ git clone https://framagit.org/framasoft/mobilizon live && cd live
### Backend
Install Elixir dependencies
Install Elixir dependencies
```bash
mix deps.get
@@ -58,42 +58,43 @@ Configure your instance with
mix mobilizon.instance gen
```
This will ask you questions about your instance and generate an `.env.prod` file.
This will ask you questions about your instance and generate a `.env.prod` file.
### Migration
Run database migrations: `mix ecto.migrate`. You will have to do this again after most updates.
> If some migrations fail, it probably means you're not using a recent enough version of PostgreSQL,
or that you didn't installed [the required extensions](#database).
or that you haven't installed [the required extensions](#database).
### Front-end
Go into the `js/` directory
```bash
cd js/
cd js
```
and install the Javascript dependencies
```bash
yarn install
```
Finally, build the front-end with
Finally, build the front-end with
```bash
yarn run build
```
### Testing
Go back to the previous directory
```bash
cd ../
cd ..
```
Now try to run the server
Now try to run the server
```bash
mix phx.server
@@ -106,7 +107,7 @@ It runs on port 4000.
### Systemd
Copy the `support/systemd/mobilizon.service` to `/etc/systemd/system`.
Copy the `support/systemd/mobilizon.service` to `/etc/systemd/system`.
```bash
sudo cp support/systemd/mobilizon.service /etc/systemd/system/
@@ -117,15 +118,15 @@ Reload Systemd to detect your new file
```bash
sudo systemctl daemon-reload
```
And enable the service
```bash
systemctl enable --now mobilizon.service
```
It will run MobiliZon and enable startup on boot. You can follow the logs with
It will run Mobilizon and enable startup on boot. You can follow the logs with
```bash
sudo journalctl -fu mobilizon.service
```