Add a way to change block type

We use pulldown-cmark in plume-front too now, but instead of using the provided
HTML renderer, we use a custom DOM renderer, which let us use contenteditable only where we want,
and which will allow us to add event listeners to provide a good contextual edition experience.

Also removed the character counter, as the API limits are almost unreachable.

.circleci/config.yml

@@ -0,0 +1,256 @@
+version: 2.1
+
+executors:
+  default:
+    parameters:
+      postgres:
+        type: boolean
+        default: false
+      selenium:
+        type: boolean
+        default: false
+    docker:
+    - image: plumeorg/plume-buildenv:v0.0.7
+    - image: <<#parameters.postgres>>circleci/postgres:9.6-alpine<</parameters.postgres>><<^parameters.postgres>>alpine:latest<</parameters.postgres>>
+      environment:
+        POSTGRES_USER: postgres
+        POSTGRES_DB: plume
+    - image: <<#parameters.selenium>>elgalu/selenium:latest<</parameters.selenium>><<^parameters.selenium>>alpine:latest<</parameters.selenium>>
+    working_directory: ~/projects/Plume
+    environment:
+      RUST_TEST_THREADS: 1
+      FEATURES: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+      DATABASE_URL: <<#parameters.postgres>>postgres://postgres@localhost/plume<</parameters.postgres>><<^parameters.postgres>>plume.sqlite<</parameters.postgres>>
+
+
+commands:
+  restore_env:
+    description: checkout and pull cache
+    parameters:
+      cache:
+        type: enum
+        default: none
+        enum: ["none", "clippy", "postgres", "sqlite", "release-postgres", "release-sqlite"]
+    steps:
+    - checkout
+    - run: git config --global --remove-section url."ssh://git@github.com"
+    - restore_cache:
+        keys:
+        - v0-<< parameters.cache >>-{{ checksum "Cargo.lock" }}-{{ .Branch }}
+        - v0-<< parameters.cache >>-{{ checksum "Cargo.lock" }}-master
+
+  cache:
+    description: push cache
+    parameters:
+      cache:
+        type: enum
+        enum: ["clippy", "postgres", "sqlite", "release-postgres", "release-sqlite"]
+    steps:
+    - save_cache:
+        key: v0-<< parameters.cache >>-{{ checksum "Cargo.lock" }}-{{ .Branch }}
+        paths:
+        - ~/.cargo/
+        - ./target
+
+  clippy:
+    description: run cargo clippy
+    parameters:
+      package:
+        type: string
+        default: plume
+      no_feature:
+        type: boolean
+        default: false
+    steps:
+    - run: cargo clippy <<^parameters.no_feature>>--no-default-features --features="${FEATURES}"<</parameters.no_feature>> --release -p <<parameters.package>> -- -D warnings
+
+  run_with_coverage:
+    description: run command with environment for coverage
+    parameters:
+      cmd:
+        type: string
+    steps:
+    - run: |
+       export RUSTFLAGS="-Zprofile -Zfewer-names -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Zno-landing-pads -Clink-arg=-Xlinker -Clink-arg=--no-keep-memory -Clink-arg=-Xlinker -Clink-arg=--reduce-memory-overheads"
+       export CARGO_INCREMENTAL=0
+       << parameters.cmd >>
+
+  upload_coverage:
+    description: merge coverage files and upload to codecov.io
+    parameters:
+      type:
+        type: string
+    steps:
+    - run: zip -0 ccov.zip `find . -name 'plume*.gc*' -o -name 'plm*.gc*'`
+    - run: grcov ccov.zip -s . -t lcov --llvm --branch --ignore-not-existing --ignore-dir '/*' -o lcov.info
+    - run: bash <(curl -s https://codecov.io/bash) -f lcov.info -F <<parameters.type>>
+    - run: find . -name 'plume*.gc*' -delete -o -name 'plm*.gc*' -delete
+    - run: rm ccov.zip lcov.info
+
+  build:
+    description: build a package
+    parameters:
+      package:
+        type: string
+        default: plume
+      release:
+        type: boolean
+        default: false
+    steps:
+    - run: |
+            cmd="cargo build <<#parameters.release>>--release<</parameters.release>> --no-default-features --features="${FEATURES}" -p <<parameters.package>> -j"
+            for i in 36 4 2 1 1; do
+                $cmd $i && exit 0
+            done
+            exit 1
+
+jobs:
+  cargo fmt:
+    executor:
+      name: default
+    steps:
+    - restore_env
+    - run: cargo fmt --all -- --check
+
+  clippy:
+    parameters:
+      postgres:
+        type: boolean
+    executor:
+      name: default
+      postgres: << parameters.postgres >>
+    steps:
+    - restore_env:
+        cache: clippy
+    - clippy
+    - clippy:
+        package: plume-cli
+    - clippy:
+        package: plume-front
+        no_feature: true
+    - cache:
+        cache: clippy
+
+  unit:
+    parameters:
+      postgres:
+        type: boolean
+    executor:
+      name: default
+      postgres: << parameters.postgres >>
+    steps:
+    - restore_env:
+        cache: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+    - run_with_coverage:
+        cmd: |
+          cmd="cargo test --all --exclude plume-front --exclude plume-macro --no-run --no-default-features --features=${FEATURES} -j"
+          for i in 36 4 2 1 1; do
+              $cmd $i && break
+          done
+          cargo test --all --exclude plume-front --exclude plume-macro --no-default-features --features="${FEATURES}" -j1 -- --test-threads=1
+    - upload_coverage:
+        type: unit
+    - cache:
+        cache: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+
+  integration:
+    parameters:
+      postgres:
+        type: boolean
+    executor:
+      name: default
+      postgres: << parameters.postgres >>
+      selenium: true
+    steps:
+    - restore_env:
+        cache: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+    - run: cargo web deploy -p plume-front
+    - run_with_coverage:
+        cmd: |
+            cmd="cargo install --debug --no-default-features --features="${FEATURES}",test --force --path . -j"
+            for i in 36 4 2 1 1; do
+                $cmd $i && exit 0
+            done
+            exit 1
+    - run_with_coverage:
+        cmd: |
+            cmd="cargo install --debug --no-default-features --features="${FEATURES}" --force --path plume-cli -j"
+            for i in 36 4 2 1 1; do
+                $cmd $i && exit 0
+            done
+            exit 1
+    - run:
+        name: run test
+        command: ./script/run_browser_test.sh
+        environment:
+          BROWSER: firefox
+    - upload_coverage:
+        type: integration
+    - cache:
+        cache: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+
+  release:
+    parameters:
+      postgres:
+        type: boolean
+    executor:
+      name: default
+      postgres: << parameters.postgres >>
+    steps:
+    - restore_env:
+        cache: release-<<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+    - run: cargo web deploy -p plume-front --release
+    - build:
+        package: plume
+        release: true
+    - build:
+        package: plume-cli
+        release: true
+    - cache:
+        cache: release-<<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+    - run: ./script/generate_artifact.sh
+    - unless:
+        condition: << parameters.postgres >>
+        steps:
+        - run: ./script/upload_test_environment.sh
+    - store_artifacts:
+        path: plume.tar.gz
+        destination: plume.tar.gz
+    - store_artifacts:
+        path: wasm.tar.gz
+        destination: wasm.tar.gz
+
+  push translations:
+    executor:
+      name: default
+    steps:
+    - restore_env:
+        cache: none
+    - run: crowdin upload -b master
+
+workflows:
+  version: 2
+  build and test:
+    jobs:
+    - cargo fmt
+    - clippy:
+        postgres: false
+    - clippy:
+        postgres: true
+    - unit:
+        postgres: false
+    - unit:
+        postgres: true
+    - integration:
+        postgres: false
+    - integration:
+        postgres: true
+    - release:
+        postgres: false
+    - release:
+        postgres: true
+    - push translations:
+        filters:
+          branches:
+            only:
+              - /^master/

.circleci/images/plume-buildenv/Caddyfile

@@ -0,0 +1,6 @@
+localhost:443 {
+  proxy / localhost:7878 {
+    transparent
+  }
+  tls self_signed
+}

.circleci/images/plume-buildenv/Dockerfile

@@ -0,0 +1,37 @@
+FROM debian:stretch-20190326
+ENV PATH="/root/.cargo/bin:${PATH}"
+
+#install native/circleci/build dependancies
+RUN apt update &&\
+    apt install -y --no-install-recommends git ssh tar gzip ca-certificates default-jre&&\
+    apt install -y --no-install-recommends binutils-dev build-essential cmake curl gcc gettext git libcurl4-openssl-dev libdw-dev libelf-dev libiberty-dev libpq-dev libsqlite3-dev libssl-dev make openssl pkg-config postgresql postgresql-contrib python zlib1g-dev python3-pip zip unzip &&\
+    rm -rf /var/lib/apt/lists/*
+
+#install and configure rust
+RUN curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly-2019-03-23 -y &&\
+    rustup component add rustfmt clippy &&\
+    rustup component add rust-std --target wasm32-unknown-unknown
+
+#compile some deps
+RUN cargo install cargo-web &&\
+    cargo install grcov &&\
+    strip /root/.cargo/bin/* &&\
+    rm -fr ~/.cargo/registry
+
+#set some compilation parametters
+COPY cargo_config /root/.cargo/config
+
+#install selenium for front end tests
+RUN pip3 install selenium
+
+#install and configure caddy
+RUN curl https://getcaddy.com | bash -s personal
+COPY Caddyfile /Caddyfile
+
+#install crowdin
+RUN mkdir /crowdin && cd /crowdin &&\
+    curl -O https://downloads.crowdin.com/cli/v2/crowdin-cli.zip &&\
+    unzip crowdin-cli.zip && rm crowdin-cli.zip &&\
+    cd * && mv crowdin-cli.jar /usr/local/bin && cd && rm -rf /crowdin &&\
+    /bin/echo -e '#!/bin/sh\njava -jar /usr/local/bin/crowdin-cli.jar $@' > /usr/local/bin/crowdin &&\
+    chmod +x /usr/local/bin/crowdin

.circleci/images/plume-buildenv/build_and_push.sh

@@ -0,0 +1,4 @@
+#!/bin/bash
+[ "$1" = "" ] && echo "you must provide one argument, the build version" && exit 1
+docker build -t plumeorg/plume-buildenv:$1 .
+docker push plumeorg/plume-buildenv:$1

.circleci/images/plume-buildenv/cargo_config

@@ -0,0 +1,3 @@
+[target.x86_64-unknown-linux-gnu]
+# link dead code for coverage, attempt to reduce linking memory usage to not get killed
+rustflags = ["-Clink-args=-Xlinker --no-keep-memory -Xlinker --reduce-memory-overheads"]

.codecov.yml

@@ -0,0 +1,26 @@
+codecov:
+  notify:
+    require_ci_to_pass: yes
+
+coverage:
+  precision: 2
+  round: down
+  range: "70...100"
+
+  status:
+    project: no
+    patch: no
+    changes: no
+
+parsers:
+  gcov:
+    branch_detection:
+      conditional: yes
+      loop: yes
+      method: no
+      macro: no
+
+comment:
+  layout: "header, diff"
+  behavior: default
+  require_changes: no

.editorconfig

@@ -5,10 +5,11 @@ end_of_line = lf
 insert_final_newline = true
 trim_trailing_whitespace = true
 
-[*.{js,rs,css,tera}]
+[*.{js,rs,css,tera,html}]
 charset = utf-8
+indent_size = 4
 
-[*.{rs,tera,css}]
+[*.{rs,tera,css,html}]
 indent_style = space
 indent_size = 4
 

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,18 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'C: Bug'
+assignees: ''
+
+---
+
+<!-- Describe your bug, explaining how to reproduce it, and what was expected -->
+
+
+
+<!-- Please fill the following information when relevant (or remove them if not) -->
+
+- **Plume version:** You can find it in the footer of your instance. If you know the exact commit, please also add it.
+- **Operating system:**
+- **Web Browser:**

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.gitignore

@@ -1,10 +1,23 @@
-
 rls
 /target
 **/*.rs.bk
 rls
 translations
-po/*.po~
+*.po~
 .env
 Rocket.toml
-media
+!.gitkeep
+static/media
+docker-compose.yml
+*.db
+*.sqlite
+*.sqlite3
+*.swp
+tags.*
+!tags.rs
+search_index
+main.css
+*.wasm
+*.js
+.buildconfig
+__pycache__

.travis.yml

@@ -1,4 +0,0 @@
-language: rust
-rust:
-  - nightly
-cache: cargo

CODE_OF_CONDUCT.md

@@ -0,0 +1,2 @@
+You can read our Code of Conduct [here](https://docs.joinplu.me/organization/code-of-conduct).
+By contributing to this repository, you agree to be bound by this Code of Conduct.

Cargo.toml

@@ -1,61 +1,82 @@
 [package]
-authors = ["Bat' <baptiste@gelez.xyz>"]
+authors = ["Plume contributors"]
 name = "plume"
-version = "0.2.0"
+version = "0.3.0"
+repository = "https://github.com/Plume-org/Plume"
+
 [dependencies]
 activitypub = "0.1.3"
+askama_escape = "0.1"
 atom_syndication = "0.6"
-colored = "1.6"
-dotenv = "0.13"
-failure = "0.1"
-gettext-rs = "0.4"
+clap = "2.33"
+colored = "1.8"
+dotenv = "0.14"
+gettext = { git = "https://github.com/Plume-org/gettext/", rev = "294c54d74c699fbc66502b480a37cc66c1daa7f3" }
+gettext-macros = { git = "https://github.com/Plume-org/gettext-macros/", rev = "a7c605f7edd6bfbfbfe7778026bfefd88d82db10" }
+gettext-utils = { git = "https://github.com/Plume-org/gettext-macros/", rev = "a7c605f7edd6bfbfbfe7778026bfefd88d82db10" }
 guid-create = "0.1"
 heck = "0.3.0"
-multipart = "0.15"
-rpassword = "2.0"
+lettre = { git = "https://github.com/lettre/lettre", rev = "c988b1760ad8179d9e7f3fb8594d2b86cf2a0a49" }
+lettre_email = { git = "https://github.com/lettre/lettre", rev = "c988b1760ad8179d9e7f3fb8594d2b86cf2a0a49" }
+num_cpus = "1.0"
+rocket = "0.4.0"
+rocket_contrib = { version = "0.4.0", features = ["json"] }
+rocket_i18n = { git = "https://github.com/Plume-org/rocket_i18n", rev = "e922afa7c366038b3433278c03b1456b346074f2" }
+rpassword = "3.0"
+runtime-fmt = "0.3.0"
+scheduled-thread-pool = "0.2.0"
 serde = "1.0"
-serde_derive = "1.0"
 serde_json = "1.0"
-tera = "0.11"
-validator = "0.7"
-validator_derive = "0.7"
-webfinger = "0.3"
-workerpool = "1.1"
+serde_qs = "0.4"
+shrinkwraprs = "0.2.1"
+validator = "0.8"
+validator_derive = "0.8"
+webfinger = "0.4.1"
+
+[[bin]]
+name = "plume"
+path = "src/main.rs"
 
 [dependencies.chrono]
 features = ["serde"]
 version = "0.4"
 
+[dependencies.ctrlc]
+features = ["termination"]
+version = "3.1.2"
+
 [dependencies.diesel]
-features = ["postgres", "r2d2", "chrono"]
+features = ["r2d2", "chrono"]
 version = "*"
 
+[dependencies.multipart]
+default-features = false
+features = ["server"]
+version = "0.16"
+
+[dependencies.plume-api]
+path = "plume-api"
+
 [dependencies.plume-common]
 path = "plume-common"
 
 [dependencies.plume-models]
 path = "plume-models"
 
-[dependencies.rocket]
-git = "https://github.com/SergioBenitez/Rocket"
-rev = "55459db7732b9a240826a5c120c650f87e3372ce"
-
-[dependencies.rocket_codegen]
-git = "https://github.com/SergioBenitez/Rocket"
-rev = "55459db7732b9a240826a5c120c650f87e3372ce"
-
-[dependencies.rocket_contrib]
-features = ["tera_templates", "json"]
-git = "https://github.com/SergioBenitez/Rocket"
-rev = "55459db7732b9a240826a5c120c650f87e3372ce"
-
 [dependencies.rocket_csrf]
-git = "https://github.com/fdb-hiroshima/rocket_csrf"
-rev = "5d23ba4c6c2ee4c41040d428d24344db3d29997f"
+git = "https://github.com/Plume-org/rocket_csrf"
+rev = "89ecb380266234f858c651354216bf5bf3cc09b2"
 
-[dependencies.rocket_i18n]
-git = "https://github.com/BaptisteGelez/rocket_i18n"
-rev = "75a3bfd7b847324c078a355a7f101f8241a9f59b"
+[build-dependencies]
+ructe = "0.6.2"
+rsass = "0.9"
+
+[features]
+default = ["postgres"]
+postgres = ["plume-models/postgres", "diesel/postgres"]
+sqlite = ["plume-models/sqlite", "diesel/sqlite"]
+debug-mailer = []
+test = []
 
 [workspace]
-members = ["plume-models", "plume-common"]
+members = ["plume-api", "plume-cli", "plume-models", "plume-common", "plume-front", "plume-macro"]

Dockerfile

@@ -1,6 +1,7 @@
-FROM rust:1-stretch
+FROM rust:1-stretch as builder
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
+    ca-certificates \
     gettext \
     postgresql-client \
     libpq-dev \
@@ -10,11 +11,35 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     make \
     openssl \
     libssl-dev
+
+WORKDIR /scratch
+COPY script/wasm-deps.sh .
+RUN chmod a+x ./wasm-deps.sh && sleep 1 && ./wasm-deps.sh
+
 WORKDIR /app
-COPY Cargo.toml Cargo.lock ./
-RUN cargo install diesel_cli --no-default-features --features postgres --version '=1.2.0'
+COPY Cargo.toml Cargo.lock rust-toolchain ./
+RUN cargo install cargo-web
+
 COPY . .
-RUN cargo build
-RUN rm -rf target/debug/incremental
-CMD ["cargo", "run"]
+
+RUN chmod a+x ./script/plume-front.sh && sleep 1 && ./script/plume-front.sh
+RUN cargo install --path ./ --force --no-default-features --features postgres
+RUN cargo install --path plume-cli --force --no-default-features --features postgres
+RUN cargo clean
+
+FROM debian:stretch-slim
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    ca-certificates \
+    libpq5 \
+    libssl1.1
+
+WORKDIR /app
+
+COPY --from=builder /app /app
+COPY --from=builder /usr/local/cargo/bin/plm /bin/
+COPY --from=builder /usr/local/cargo/bin/plume /bin/
+
+CMD ["plume"]
+
 EXPOSE 7878

Dockerfile.dev

@@ -0,0 +1,33 @@
+FROM rust:1-stretch
+
+RUN apt-get update && apt-get install -y --no-install-recommends \
+    ca-certificates \
+    gettext \
+    postgresql-client \
+    libpq-dev \
+    git \
+    curl \
+    gcc \
+    make \
+    openssl \
+    libssl-dev
+
+WORKDIR /scratch
+COPY script/wasm-deps.sh .
+RUN chmod a+x ./wasm-deps.sh && sleep 1 && ./wasm-deps.sh
+
+WORKDIR /app
+COPY Cargo.toml Cargo.lock rust-toolchain ./
+RUN cargo install diesel_cli --no-default-features --features postgres --version '=1.3.0'
+RUN cargo install cargo-web
+
+COPY . .
+
+RUN chmod a+x ./script/plume-front.sh && sleep 1 && ./script/plume-front.sh
+RUN cargo install --path ./ --force --no-default-features --features postgres
+RUN cargo install --path plume-cli --force --no-default-features --features postgres
+RUN cargo clean
+
+CMD ["plume"]
+
+EXPOSE 7878

README.md

@@ -1,13 +1,55 @@
-# Plume [![Build Status](https://travis-ci.org/Plume-org/Plume.svg?branch=master)](https://travis-ci.org/Plume-org/Plume)
+<h1 align="center">
+  <img src="https://raw.githubusercontent.com/Plume-org/Plume/master/static/icons/trwnh/feather/plumeFeather64.png" alt="Plume's logo">
+  Plume
+</h1>
+<p align="center">
+  <a href="https://github.com/Plume-org/Plume/"><img alt="CircleCI" src="https://img.shields.io/circleci/build/gh/Plume-org/Plume.svg"></a>
+  <a href="https://codecov.io/gh/Plume-org/Plume"><img src="https://codecov.io/gh/Plume-org/Plume/branch/master/graph/badge.svg" alt="Code coverage"></a>
+  <a title="Crowdin" target="_blank" href="https://crowdin.com/project/plume"><img src="https://d322cqt584bo4o.cloudfront.net/plume/localized.svg"></a>
+  <a href="https://hub.docker.com/r/plumeorg/plume"><img alt="Docker Pulls" src="https://img.shields.io/docker/pulls/plumeorg/plume.svg"></a>
+  <a href="https://liberapay.com/Plume"><img alt="Liberapay patrons" src="https://img.shields.io/liberapay/patrons/Plume.svg"></a>
+</p>
+<p align="center">
+  <a href="https://joinplu.me/">Website</a>
+  —
+  <a href="https://docs.joinplu.me/">Documentation</a>
+  —
+  <a href="https://docs.joinplu.me/contribute">Contribute</a>
+  —
+  <a href="https://joinplu.me/#instances">Instances list</a>
+</p>
 
-Federated blogging engine, based on ActivityPub. It uses the Rocket framework, and Diesel to interact with the database.
+Plume is a **federated blogging engine**, based on *ActivityPub*. It is written in *Rust*, with the *Rocket* framework, and *Diesel* to interact with the database.
+The front-end uses *Ructe* templates, *WASM* and *SCSS*.
 
-[**Demo instance**](https://baptiste.gelez.xyz/)
+## Features
 
-It is not yet ready for production use, but we have all the basic features (account management, blogs, articles, comments, etc) and a basic federation.
+A lot of features are still missing, but what is already here should be quite stable. Current and planned features include:
 
-Feel free to join our Matrix room: `#plume:disroot.org` to discuss about the project!
+- **A blog-centric approach**: you can create as much blogs as you want with your account, to keep your different publications separated.
+- **Media management**: you can upload pictures to illustrate your articles, but also audio files if you host a podcast, and manage them all from Plume.
+- **Federation**: Plume is part of a network of interconnected websites called the Fediverse. Each of these websites (often called *instances*) have their own
+rules and thematics, but they can all communicate with each other.
+- **Collaborative writing**: invite other people to your blogs, and write articles together.
 
-If you are interested in coding, check out the [development guide](https://github.com/Plume-org/Plume/blob/master/docs/DEVELOPMENT.md). You can also help by reporting issues, suggesting features, or writing documentation for instance.
+## Get involved
 
-If you would like to help by translating Plume, we also have [a guide for you](https://github.com/Plume-org/Plume/blob/master/docs/INTERNATIONALIZATION.md)!
+If you want to have regular news about the project, the best place is probably [our blog](https://fediverse.blog/~/PlumeDev), or our Matrix room: [`#plume:disroot.org`](https://riot.im/app/#/room/#plume:disroot.org).
+
+If you want to contribute more, a good first step is to read [our contribution guides](https://docs.joinplu.me/contribute). We accept all kind of contribution:
+
+- [Back-end or front-end development](https://docs.joinplu.me/contribute/development/)
+- [Translations](https://docs.joinplu.me/contribute/translations/)
+- [Documentation](https://docs.joinplu.me/contribute/documentation/)
+- UI and/or UX design (we don't have a dedicated guide yet, but [we can talk](https://docs.joinplu.me/contribute/discussion/) to see how we can work together!)
+- [Taking part in discussions](https://docs.joinplu.me/contribute/discussion/)
+- [Financial support](https://docs.joinplu.me/contribute/donations/)
+
+But this list is not exhaustive and if you want to contribute differently you are welcome too!
+
+As we want the various spaces related to the project (GitHub, Matrix, Loomio, etc) to be as safe as possible for everyone, we adopted [a code of conduct](https://docs.joinplu.me/organization/code-of-conduct). Please read it and make sure you accept it before contributing.
+
+## Starting your own instance
+
+We provide various way to install Plume: from source, with pre-built binaries, with Docker or with YunoHost.
+For detailed explanations, please refer to [the documentation](https://docs.joinplu.me/installation/).

build.rs

@@ -0,0 +1,76 @@
+extern crate rsass;
+extern crate ructe;
+use ructe::*;
+use std::process::{Command, Stdio};
+use std::{env, fs::*, io::Write, path::PathBuf};
+
+fn compute_static_hash() -> String {
+    //"find static/ -type f ! -path 'static/media/*' | sort | xargs stat -c'%n %Y' | openssl dgst -r"
+
+    let find = Command::new("find")
+        .args(&["static/", "-type", "f", "!", "-path", "static/media/*"])
+        .stdout(Stdio::piped())
+        .spawn()
+        .expect("failed find command");
+
+    let sort = Command::new("sort")
+        .stdin(find.stdout.unwrap())
+        .stdout(Stdio::piped())
+        .spawn()
+        .expect("failed sort command");
+
+    let xargs = Command::new("xargs")
+        .args(&["stat", "-c'%n %Y'"])
+        .stdin(sort.stdout.unwrap())
+        .stdout(Stdio::piped())
+        .spawn()
+        .expect("failed xargs command");
+
+    let mut sha = Command::new("openssl")
+        .args(&["dgst", "-r"])
+        .stdin(xargs.stdout.unwrap())
+        .output()
+        .expect("failed openssl command");
+
+    sha.stdout.resize(64, 0);
+    String::from_utf8(sha.stdout).unwrap()
+}
+
+fn main() {
+    let out_dir = PathBuf::from(env::var("OUT_DIR").unwrap());
+    let in_dir = PathBuf::from(env::var("CARGO_MANIFEST_DIR").unwrap()).join("templates");
+    compile_templates(&in_dir, &out_dir).expect("compile templates");
+
+    println!("cargo:rerun-if-changed=static/css/_article.scss");
+    println!("cargo:rerun-if-changed=static/css/_forms.scss");
+    println!("cargo:rerun-if-changed=static/css/_global.scss");
+    println!("cargo:rerun-if-changed=static/css/_header.scss");
+    println!("cargo:rerun-if-changed=static/css/_variables.scss");
+    println!("cargo:rerun-if-changed=static/css/main.scss");
+    let mut out = File::create("static/css/main.css").expect("Couldn't create main.css");
+    out.write_all(
+        &rsass::compile_scss_file(
+            "static/css/main.scss".as_ref(),
+            rsass::OutputStyle::Compressed,
+        )
+        .expect("Error during SCSS compilation"),
+    )
+    .expect("Couldn't write CSS output");
+
+    let cache_id = &compute_static_hash()[..8];
+    println!("cargo:rerun-if-changed=target/deploy/plume-front.wasm");
+    copy("target/deploy/plume-front.wasm", "static/plume-front.wasm")
+        .and_then(|_| read_to_string("target/deploy/plume-front.js"))
+        .and_then(|js| {
+            write(
+                "static/plume-front.js",
+                js.replace(
+                    "\"plume-front.wasm\"",
+                    &format!("\"/static/cached/{}/plume-front.wasm\"", cache_id),
+                ),
+            )
+        })
+        .ok();
+
+    println!("cargo:rustc-env=CACHE_ID={}", cache_id)
+}

crowdin.yml

@@ -0,0 +1,8 @@
+"project_identifier": "plume"
+"api_key_env": CROWDIN_API_KEY
+preserve_hierarchy: true
+files:
+  - source: /po/plume/plume.pot
+    translation: /po/plume/%two_letters_code%.po
+  - source: /po/plume-front/plume-front.pot
+    translation: /po/plume-front/%two_letters_code%.po

diesel.toml

@@ -0,0 +1,5 @@
+# For documentation on how to configure this file,
+# see diesel.rs/guides/configuring-diesel-cli
+
+[print_schema]
+file = "plume-models/src/schema.rs"

docs/DEVELOPMENT.md

@@ -1,87 +0,0 @@
-# Development Guide
-
-## Installing the development environment
-
-Please refer to the [installation guide](INSTALL.md).
-
-## Testing the federation
-
-To test the federation, you'll need to setup another database (see "Setup the database"),
-also owned by the "plume" user, but with a different name. Then, you'll need to run the
-migrations for this database too.
-
-```
-diesel migration run --database-url postgres://plume:plume@localhost/my_other_plume_db
-```
-
-To run this other instance, you'll need to give two environment variables:
-
-- `ROCKET_PORT`, the port on which your app will run
-- `DB_NAME`, the name of the database you just created
-
-```
-ROCKET_PORT=3033 DB_NAME=my_other_plume_db cargo run
-```
-
-If you don't want to setup HTTPS locally, you can also disable it by running your instance with `USE_HTTPS=0` set.
-
-```
-USE_HTTPS=0 cargo run
-```
-
-## Making a Pull Request
-To create an upstream fork of the repository in GitHub, click "Fork" in the top right button on the main page of the [Plume repository](https://github.com/Plume-org/Plume). Now, in the command line, set another remote for the repository by running the following command, replacing `myname` with the name under which you forked the repo. You can use another name besides `upstream` if you prefer. Using [SSH](https://help.github.com/articles/connecting-to-github-with-ssh/) is recommended.
-
-```
-git remote add upstream git@github.com/myname/Plume.git
-# Alt # git remote add upstream https://github.com/myname/Plume.git
-```
-
-Now, make any changes to the code you want. After committing your changes, push to the upstream fork. Once your changes are made, visit the GitHub page for your fork and select "New pull request". Add descriptive text, any issue numbers using hashtags to reference the issue number, screenshots of your changes if relevant, a description of how you tested your changes, and any other information that will help the project maintainers be able to quickly accept your pull requests.
-
-The project maintainers may suggest further changes to improve the pull request even more. After implementing this locally, you can push to your upstream fork again and the changes will immediately show up in the pull request after pushing. Once all the suggested changes are made, the pull request may be accepted. Thanks for contributing.
-
-## When working with Tera templates
-
-When working with the interface, or any message that will be displayed to the final user, keep in mind that Plume is an internationalized software. To make sure that the parts of the interface you are changing are translatable, you should:
-
-- Use the `_` and `_n` filters instead of directly writing strings in your HTML markup
-- Add the strings to translate to the `po/plume.pot` file
-
-Here is an example: let's say we want to add two strings, a simple one and one that may deal with plurals. The first step is to add them to whatever template we want to display them in:
-
-```jinja
-<p>{{ "Hello, world!" | _ }}</p>
-
-<p>{{ "You have {{ count }} new notifications" | _n(singular="You have one new notification", count=n_notifications) }}</p>
-```
-
-As you can see, the `_` doesn't need any special argument to work, but `_n` requires `singular` (the singular form, in English) and `count` (the number of items, to determine which form to use) to be present. Note that any parameters given to these filters can be used as regular Tera variables inside of the translated strings, like we are doing with the `count` variable in the second string above.
-
-The second step is to add them to POT file. To add a simple message, just do:
-
-```po
-msgid "Hello, world" # The string you used with your filter
-msgstr "" # Always empty
-```
-
-For plural forms, the syntax is a bit different:
-
-```po
-msgid "You have one new notification" # The singular form
-msgid_plural "You have {{ count }} new notifications" # The plural one
-msgstr[0] ""
-msgstr[1] ""
-```
-
-And that's it! Once these new messages will have been translated, they will correctly be displayed in the requested locale!
-
-## Code Style
-
-For Rust, use the standard style. `rustfmt` can help you keeping your code clean.
-
-For CSS, the only rule is to use One True Brace Style.
-
-For JavaScript, we use [the JavaScript Standard Style](https://standardjs.com/).
-
-For HTML/Tera templates, we use HTML5 syntax.

docs/ENV-VARS.md

@@ -1,22 +0,0 @@
-# Useful Environment Variables
-
-Plume relies on some environment variables for some configuration options. You can either set them before
-starting the app with `cargo run` or write them in a `.env` file to have automatically loaded.
-
-Here are the variables that Plume uses:
-
-- `BASE_URL`: the domain name, or IP and port on which Plume is listening. It is used in all federation-related code.
-- `DB_URL`: the URL of the PostgreSQL database, used by Plume (`postgres://plume:plume@localhost/plume` by default).
-- `POSTGRES_USER`: if you just want to use a different PostgreSQL user name, and keep the rest of the default URL.
-- `POSTGRES_PASSWORD`: same as `POSTGRES_USER`, but for the password.
-- `USE_HTTPS`: if it is `0`, federation and medias will be using HTTP by default (`1` by default).
-- `ROCKET_ADDRESS`: the adress on which Plume should listen (`0.0.0.0` by default).
-- `ROCKET_PORT`: the port on which Plume should listen ([`7878` by default](https://twitter.com/ag_dubs/status/852559264510070784))
-- `ROCKET_SECRET_KEY`: key used to sign private cookies and for CSRF protection. If it is not set, it will be regenerated everytime you restart Plume,
-meaning that all your users will get disconnected. You can generate one with `openssl rand -base64 32`.
-
-## Diesel
-
-Diesel, the tool we use to run migrations may be configured with the `DATABASE_URL` which should contain the URL of the
-PostgreSQL database. Otherwise, you can specify `--database-url YOUR-URL` everytime you run a `diesel` command.
-

docs/INSTALL.md

@@ -1,423 +0,0 @@
-# Installing Plume (for development or production)
-
-## Prerequisites
-
-In order to be installed and to work correctly, Plume needs:
-
-- *Git* (to get the code)
-- *Curl* (for RustUp, the Rust installer)
-- *GCC* and *make*  (to compile C dependencies)
-- *PostgreSQL* (for the database)
-- *GetText* (to manage translations)
-- *Rust* and *Cargo* (to build the code)
-- *OpenSSL* and *OpenSSL librairies* (for security)
-
-All the following instructions will need a terminal.
-
-Here are the commands to install PostgreSQL and GetText on various operating systems.
-Some of them may need root permissions.
-
-You can also install the project using Docker and docker-compose, please refer
-to the `Docker install` section.
-
-On **Debian**:
-
-```bash
-apt update
-apt install gettext postgresql postgresql-contrib libpq-dev git curl gcc make openssl libssl-dev
-```
-
-On **Fedora**, **CentOS** or **RHEL**:
-
-```bash
-dnf install postgresql-server postgresql-contrib mariadb-devel libsq3-devel libpqxx libpqxx-devel git curl gcc make openssl openssl-devel gettext
-```
-
-On **Gentoo**:
-
-```bash
-emerge --sync
-emerge -av postgresql eselect-postgresql gettext && emerge --ask dev-vcs/git
-```
-
-On **Mac OS X**, with [Homebrew](https://brew.sh/):
-
-```bash
-brew update
-brew install postgres gettext git
-```
-
-## Creating a new user (optional)
-
-This step is recommended if you are in a **production environment**, but it is not necessary.
-
-```bash
-adduser plume
-su - plume
-cd ~
-```
-
-Creating a new user will let you use systemd to manage Plume if you want (see the dedicated section below).
-
-## Installing Rust and Cargo
-
-We said that Plume needed Rust and Cargo to work, but we didn't install them at the same time as PostgreSQL and GetText, because there is an universal installation method called RustUp.
-
-You can install it on **GNU/Linux** and **Mac OS X** with:
-
-```bash
-curl https://sh.rustup.rs -sSf | sh
-```
-
-When asked, choose the *"1) Proceed with installation (default)"* option.
-
-Then run this command to be able to run cargo in the current session:
-
-```bash
-export PATH="$PATH:/home/plume/.cargo/bin:/home/plume/.local/bin:/usr/local/sbin"
-```
-
-On **Windows**, you'll need, if you don't already have them, to download and install the [Visual C++ 2015 Build Tools](https://www.microsoft.com/en-us/download/details.aspx?id=48159). Then, download the [rustup installer](https://www.rust-lang.org/en-US/install.html) and run it.
-
-## Getting and compiling the Plume source code
-
-Plume needs to be compiled from source.
-
-```bash
-git clone https://github.com/Plume-org/Plume.git
-cd Plume
-
-# This may take some time as RustUp will download all
-# the required Rust components, and Cargo will download
-# and compile all dependencies.
-cargo build
-```
-
-We may provide precompiled packages and Docker images in the future; if you have experience in these fields and want to help, feel free to discuss this in issues and to propose pull-requests!
-
-## Configuring PostgreSQL
-
-You can either run PostgreSQL from the machine that runs Plume, or from another server. We recommend you to use the first setup for development environments, or in production for small instances.
-
-In the first case, just run this command after the PostgreSQL installation, to start it:
-
-```
-service postgresql start
-```
-
-If you want to have two separate machines, run these commands on the database server once you've installed the dependencies mentioned above on both servers:
-
-```bash
-service postgresql start
-su - postgres
-createuser -d -P plume
-createdb -O plume plume
-```
-
-
-## Running migrations
-
-Migrations are scripts used to update the database. They are run by a tool called Diesel, which can be installed with:
-
-```bash
-cargo install diesel_cli --no-default-features --features postgres --version '=1.2.0'
-```
-
-Plume should normally run migrations on your behalf as needed, but if you want to run them manually, use the following command:
-
-```bash
-diesel migration run --database-url postgres://USER:PASSWORD@IP:PORT/plume
-```
-
-This command may be useful if you decided to use a separate database server.
-
-## Starting Plume
-
-When you launch Plume for the first time, it will ask you a few questions to setup your instance before it actually launches. To start it, run these commands.
-
-```
-# Optional, only do it if the database URL is not
-# postgres://plume:plume@localhost/plume
-export DB_URL=postgres://plume:PASSWORD@DBSERVERIP:DBPORT/plume
-
-# Create the media directory, where uploads will be stored
-mkdir media
-
-# Actually start Plume
-cargo run
-```
-
-## Docker install
-
-You can use `docker` and `docker-compose` in order to manage your Plume instance and
-have it isolated from your host:
-
-```
-git clone git@github.com:Plume-org/Plume.git
-cd Plume
-cp docs/docker-compose.sample.yml docker-compose.yml
-cp docs/docker.sample.env .env
-# build the containers
-docker-compose build
-# launch the database
-docker-compose up -d postgres
-# run the migrations
-docker-compose run --rm plume diesel migration run
-# run interactive setup
-docker-compose run --rm plume bash
-cargo run
-# copy the env file and paste it in your host .env file
-cat .env
-# leave the container
-exit
-# launch your instance for good
-docker-compose up -d
-```
-
-Then, you can configure your reverse proxy.
-
-## Configuring Nginx
-
-Here is a sample Nginx configuration for a Plume instance (replace `blog.example.com` with your domain name):
-
-```nginx
-server {
-    listen 80;
-    listen [::]:80;
-    server_name blog.example.com;
-
-    location /.well-known/acme-challenge {}
-    location / {
-        return 301 https://$host$request_uri;
-    }
-}
-
-server {
-    listen 443 ssl http2;
-    listen [::]:443 ssl http2;
-    server_name blog.example.org;
-    
-    access_log  /var/log/nginx/access.log;
-    root /home/plume/Plume/ ;
-
-    SSLCertificateFile /etc/letsencrypt/live/blog.example.com/cert.pem
-    SSLCertificateKeyFile /etc/letsencrypt/live/blog.example.com/privkey.pem
-    SSLCertificateChainFile /etc/letsencrypt/live/blog.example.com/chain.pem
-
-    # for ssl conf: https://cipherli.st/
-	ssl_protocols TLSv1.2 TLSv1.3;# Requires nginx >= 1.13.0 else use TLSv1.2
-	ssl_prefer_server_ciphers on;
-	ssl_dhparam /etc/letsencrypt/ssl-dhparams.pem;# openssl dhparam -out /etc/letsencrypt/ssl-dhparam.pem 4096
-	ssl_ciphers ECDHE-RSA-AES256-GCM-SHA512:DHE-RSA-AES256-GCM-SHA512:ECDHE-RSA-AES256-GCM-SHA384:DHE-RSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-SHA384;
-	ssl_ecdh_curve secp384r1; # Requires nginx >= 1.1.0
-	ssl_session_timeout  10m;
-	ssl_session_cache shared:SSL:10m;
-	ssl_session_tickets off; # Requires nginx >= 1.5.9
-	ssl_stapling on; # Requires nginx >= 1.3.7
-	ssl_stapling_verify on; # Requires nginx => 1.3.7
-	resolver 9.9.9.9 80.67.169.12 valid=300s;
-	resolver_timeout 5s;
-	add_header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload";
-	add_header X-Frame-Options DENY;
-	add_header X-Content-Type-Options nosniff;
-	add_header X-XSS-Protection "1; mode=block";
-	add_header Content-Security-Policy "default-src 'self';";
-	add_header Content-Security-Policy "frame-ancestors 'self'";
-
-    location ~*  \.(jpg|jpeg|png|gif|ico|js|pdf)$ {
-        add_header Cache-Control "public";
-        expires 7d;
-    }
-
-    location / {
-        proxy_pass http://localhost:7878/;
-        proxy_set_header Host $http_host;
-        proxy_set_header X-Real-IP $remote_addr;
-        proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
-        proxy_set_header X-Forwarded-Proto $scheme;
-        client_max_body_size 10m;
-    }
-}
-```
-
-## Configuring Apache
-
-If you prefer Apache, you can use this configuration (here too, replace `blog.example.com` with your domain):
-
-```apache
-<VirtualHost *:80>
-    ServerName blog.example.com
-    Redirect / https://blog.example.com/
-</VirtualHost>
-
-<VirtualHost *:443>
-   ServerAdmin admin@example.com
-   ServerName blog.example.com
-<Directory "/home/plume/Plume">
-    Header always set Referrer-Policy "strict-origin-when-cross-origin"
-    Header always set Strict-Transport-Security "max-age=31536000"
-    SSLEngine on
-
-    # for cipher conf: https://cipherli.st/
-    SSLCipherSuite EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH
-    SSLProtocol All -SSLv2 -SSLv3 -TLSv1 -TLSv1.1
-    SSLHonorCipherOrder On
-    Header always set Strict-Transport-Security "max-age=63072000; includeSubDomains; preload"
-    Header always set X-Frame-Options DENY
-    Header always set X-Content-Type-Options nosniff
-    SSLCompression off
-    SSLUseStapling on
-    SSLStaplingCache "shmcb:logs/stapling-cache(150000)"
-
-    # Requires Apache >= 2.4.11
-    SSLSessionTickets Off
-
-    SSLCertificateFile /etc/letsencrypt/live/blog.example.com/cert.pem
-    SSLCertificateKeyFile /etc/letsencrypt/live/blog.example.com/privkey.pem
-    SSLCertificateChainFile /etc/letsencrypt/live/blog.example.com/chain.pem
-
-    ProxyPreserveHost On
-    RequestHeader set X-Forwarded-Proto "https"
-
-    ProxyPass / http://127.0.0.1:7878/
-    ProxyPassReverse / http://127.0.0.1:7878/
-</VirtualHost>
-```
-
-## Systemd integration
-
-If you want to manage your Plume instance with systemd, you can use the following unit file (to be saved in `/etc/systemd/system/plume.service`):
-
-```toml
-[Unit]
-Description=plume
-
-[Service]
-Type=simple
-User=plume
-WorkingDirectory=/home/plume/Plume
-ExecStart=/home/plume/.cargo/bin/cargo run
-TimeoutSec=30
-Restart=always
-
-[Install]
-WantedBy=multi-user.target
-```
-
-## SysVinit integration
-
-This script can also be useful if you are using SysVinit.
-
-```bash
-#!/bin/sh
-### BEGIN INIT INFO
-# Provides:
-# Required-Start:    $remote_fs $syslog
-# Required-Stop:     $remote_fs $syslog
-# Default-Start:     2 3 4 5
-# Default-Stop:      0 1 6
-# Short-Description: Start daemon at boot time
-# Description:       Federated blogging
-# Based on https://raw.githubusercontent.com/fhd/init-script-template/master/template
-### END INIT INFO
-
-dir="/home/plume/Plume"
-cmd="/home/plume/.cargo/bin/cargo run"
-user="plume"
-
-name=`basename $0`
-pid_file="/var/run/$name.pid"
-stdout_log="/home/plume/Plume/plume.log"
-stderr_log="/home/plume/Plume/plume.err"
-
-get_pid() {
-    cat "$pid_file"
-}
-
-is_running() {
-    [ -f "$pid_file" ] && ps -p `get_pid` > /dev/null 2>&1
-}
-
-case "$1" in
-    start)
-    if is_running; then
-        echo "Already started"
-    else
-        echo "Starting $name"
-        cd "$dir"
-        if [ -z "$user" ]; then
-            sudo $cmd >> "$stdout_log" 2>> "$stderr_log" &
-        else
-            sudo -u "$user" $cmd >> "$stdout_log" 2>> "$stderr_log" &
-        fi
-        echo $! > "$pid_file"
-        if ! is_running; then
-            echo "Unable to start, see $stdout_log and $stderr_log"
-            exit 1
-        fi
-    fi
-    ;;
-    stop)
-    if is_running; then
-        echo -n "Stopping $name.."
-        kill `get_pid`
-        for i in 1 2 3 4 5 6 7 8 9 10
-        # for i in `seq 10`
-        do
-            if ! is_running; then
-                break
-            fi
-
-            echo -n "."
-            sleep 1
-        done
-        echo
-
-        if is_running; then
-            echo "Not stopped; may still be shutting down or shutdown may have failed"
-            exit 1
-        else
-            echo "Stopped"
-            if [ -f "$pid_file" ]; then
-                rm "$pid_file"
-            fi
-        fi
-    else
-        echo "Not running"
-    fi
-    ;;
-    restart)
-    $0 stop
-    if is_running; then
-        echo "Unable to stop, will not attempt to start"
-        exit 1
-    fi
-    $0 start
-    ;;
-    status)
-    if is_running; then
-        echo "Running"
-    else
-        echo "Stopped"
-        exit 1
-    fi
-    ;;
-    *)
-    echo "Usage: $0 {start|stop|restart|status}"
-    exit 1
-    ;;
-esac
-
-exit 0
-
-```
-
-## Caveats:
-
-- Pgbouncer is not supported yet (named transactions are used).
-- Rust nightly is a moving target, dependancies can break and sometimes you need to check a few versions to find the one working (run `rustup override set nightly-2018-05-15` or `rustup override set nightly-2018-05-31` in the Plume directory if you have issues during the compilation)
-- Rust nightly 2018-06-28 is known to be failing to compile diesel 1.3.2
-
-## Acknowledgements
-
-Most of this documentation has been written by *gled-rs*. The systemd unit file, Nginx and Apache configurations have been written by *nonbinaryanargeek*. Some parts (especially the instructions to install native dependencies) are from the [Aardwolf project](https://github.com/Aardwolf-Social/aardwolf).

docs/INTERNATIONALIZATION.md

@@ -1,39 +0,0 @@
-# Making Plume available in your language
-
-*You will need to have basic git and GitHub knownledge to follow this guide. But we plan to setup a more user-friendly translation tool in the future.*
-
-To translate Plume in your language, you'll first need to make sure it is listed in the `po/LINGUAS` file. If it is not, you can ask anybody with a development environment to add it (or do it yourself if you have a development environment). Once it will be here, Plume must be launched once to generate all the needed files.
-
-Then you can start translating. Find the file corresponding to your locale, which is `po/YOUR_LOCALE.po`, and open it. Inside, you have a list of strings to translate. There are two kind of translatable strings.
-
-## Simple strings
-
-They look like this:
-
-```po
-msgid "Hello, world"
-msgstr ""
-```
-
-What is next to `msgid` is the string in English. To translate it, just fill the `msgstr` field with the translation.
-
-## Strings with plural forms
-
-Sometimes, strings may change depending on a number (for instance, a post counter). In the `.po` files, these strings look like this:
-
-```
-msgid "One post"
-msgid_plural "{{ count }} posts"
-msgstr[0] ""
-msgstr[1] ""
-```
-
-Then you should fill the two `msgstr` field, one with the singular form, the second with the plural one. If your language as more than two forms, you can add another one by following the same pattern (`msgstr[n] ""`).
-
-## Interpolation
-
-Strings you translate may contain data from Plume (a username for instance). To tell Plume where to put these data, surround their identifier by `{{` and `}}`. The identifier is also present in this form in the English string to translate (this what you can see above, with the `{{ count }} posts` message).
-
-## Note
-
-When translating, please try to be as inclusive as possible.

docs/README.md

@@ -1,7 +0,0 @@
-# Plume documentation
-
-- [Installing Plume (for development or production)](INSTALL.md)
-- [Updating your instance](UPDATE.md)
-- [Useful Environment Variables](ENV-VARS.md)
-- [Development Guide](DEVELOPMENT.md)
-- [Making Plume available in your language](INTERNATIONALIZATION.md)

docs/UPDATE.md

@@ -1,15 +0,0 @@
-# Updating your instance
-
-To update your instance, run these commands with `plume` user if you created it, or with your default user, in the Plume directory.
-
-```
-git pull origin master
-
-# If you are not using systemd
-cargo run
-
-# If you are using systemd
-service plume restart
-```
-
-That's it!

docs/_config.yml

@@ -1 +0,0 @@
-theme: jekyll-theme-cayman

docs/docker-compose.sample.yml

@@ -1,18 +0,0 @@
-version: '3'
-
-services:
-  postgres:
-    image: postgres:10.5
-    env_file: .env
-    restart: unless-stopped
-    volumes:
-      - "./data/postgres:/var/lib/postgresql/data"
-  plume:
-    build: .
-    env_file: .env
-    restart: unless-stopped
-    volumes:
-      - "./data/plume/static/media:/app/media"
-      - "./.env:/app/.env"
-    ports:
-      - "127.0.0.1:7878:7878"

docs/docker.sample.env

@@ -1,12 +0,0 @@
-BASE_URL=yourdomain.com
-# generate one with openssl rand -base64 45
-ROCKET_SECRET_KEY=randomstringhere
-
-# you can safely leave those defaults
-POSTGRES_USER=plume
-POSTGRES_PASSWORD=plume
-DB_URL=postgres://plume:plume@postgres:5432/plume
-DATABASE_URL=postgres://plume:plume@postgres:5432/plume
-USE_HTTPS=1
-ROCKET_ADDRESS=0.0.0.0
-ROCKET_PORT=7878