Merge pull request 'Support for storing media on S3' (#1149) from lx/Plume:s3 into main

Reviewed-on: https://git.joinplu.me/Plume/Plume/pulls/1149
Reviewed-by: trinity-1686a <trinity-1686a@noreply@joinplu.me>

.cargo/config.toml

@@ -0,0 +1,10 @@
+[target.wasm32-unknown-unknown]
+# required for clippy
+rustflags = [
+  "--cfg", "web_sys_unstable_apis",
+]
+
+[target.x86_64-unknown-linux-gnu]
+rustflags = [
+  "--cfg", "web_sys_unstable_apis",
+]

.circleci/config.yml

@@ -1,313 +1,263 @@
 version: 2.1
 
-aliases:
-  - &plume-docker
-    image: plumeorg/plume-buildenv:v0.0.5
-  - &defaults
+executors:
+  default:
+    parameters:
+      postgres:
+        type: boolean
+        default: false
+      selenium:
+        type: boolean
+        default: false
     docker:
-      - *plume-docker
+    - image: plumeorg/plume-buildenv:v0.8.0
+    - image: <<#parameters.postgres>>cimg/postgres:14.2<</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
-  - &postgresql
-    docker:
-      - *plume-docker
-      - image: circleci/postgres:9.6-alpine
-        environment:
-          POSTGRES_USER: postgres
-          POSTGRES_DB: plume
-    working_directory: ~/projects/Plume
-  - &selenium
-    docker:
-      - *plume-docker
-      - image: elgalu/selenium:latest
-    working_directory: ~/projects/Plume
-  - &postgresql_selenium
-    docker:
-      - *plume-docker
-      - image: circleci/postgres:9.6-alpine
-        environment:
-          POSTGRES_USER: postgres
-          POSTGRES_DB: plume
-      - image: elgalu/selenium:latest
-    working_directory: ~/projects/Plume
-
-  - &attach_workspace
-    attach_workspace:
-      at: ~/projects/Plume/
-  - &persist_to_workspace
-    persist_to_workspace:
-      root: ~/projects/Plume/
-      paths:
-        - ./
-
-  - &env_postgresql
     environment:
-      MIGRATION_DIRECTORY: migrations/postgres
-      FEATURES: postgres
-      DATABASE_URL: postgres://postgres@localhost/plume
-      RUST_TEST_THREADS: 1
-  - &env_sqlite
-    environment:
-      MIGRATION_DIRECTORY: migrations/sqlite
-      FEATURES: sqlite
-      DATABASE_URL: plume.sqlite3
       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>>
+      ROCKET_SECRET_KEY: VN5xV1DN7XdpATadOCYcuGeR/dV0hHfgx9mx9TarLdM=
 
-  - &restore_cache
-    restore_cache:
-      keys:
-        - v2-plume-notest-{{ checksum "Cargo.lock" }}
-        - v2-plume-notest
-  - &save_cache
-    save_cache:
-      key: v2-plume-notest-{{ checksum "Cargo.lock" }}
-      paths:
+
+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" }}-main
+
+  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
 
-  - &restore_cache_web
-    restore_cache:
-      keys:
-        - v2-plume-web-{{ checksum "Cargo.lock" }}
-        - v2-plume-web
-  - &save_cache_web
-    save_cache:
-      key: v2-plume-web-{{ checksum "Cargo.lock" }}
-      paths:
-        - ~/.cargo/
-        - ./target
-
-  - &restore_cache_cli
-    restore_cache:
-      keys:
-        - v2-plume-notest-{{ checksum "Cargo.lock" }}-{{ checksum "/FEATURES" }}-cli
-        - v2-plume-notest-{{ checksum "Cargo.lock" }}-{{ checksum "/FEATURES" }}
-        - v2-plume-notest-{{ checksum "Cargo.lock" }}
-        - v2-plume-notest
-  - &save_cache_cli
-    save_cache:
-      key: v2-plume-notest-{{ checksum "Cargo.lock" }}-{{ checksum "/FEATURES" }}-cli
-      paths:
-        - ~/.cargo/
-        - target
-
-  - &restore_cache_release
-    restore_cache:
-      keys:
-        - v2-plume-release-{{ checksum "Cargo.lock" }}
-        - v2-plume-release
-        - v2-plume-notest-{{ checksum "Cargo.lock" }}
-        - v2-plume-notest
-  - &save_cache_release
-    save_cache:
-      key: v2-plume-release-{{ checksum "Cargo.lock" }}
-      paths:
-        - ~/.cargo
-        - target/release
-        - target/wasm32-unknown-unknown/release
-
-  - &restore_cache_plume_dead_code
-    restore_cache:
-      keys:
-        - v2-plume-test-{{ checksum "/FEATURES" }}-{{ checksum "Cargo.lock" }}-plume
-        - v2-plume-test-{{ checksum "/FEATURES" }}-{{ checksum "Cargo.lock" }}
-        - v2-plume-test-{{ checksum "/FEATURES" }}
-        - v2-plume-notest-{{ checksum "Cargo.lock" }}-{{ checksum "/FEATURES" }}
-        - v2-plume-notest-{{ checksum "Cargo.lock" }}
-        - v2-plume-notest
-  - &save_cache_plume_dead_code
-    save_cache:
-      key: v2-plume-test-{{ checksum "/FEATURES" }}-{{ checksum "Cargo.lock" }}-plume
-      paths:
-        - ~/.cargo/
-        - target
-
-  - &test_cli
+  clippy:
+    description: run cargo clippy
+    parameters:
+      package:
+        type: string
+        default: plume
+      no_feature:
+        type: boolean
+        default: false
     steps:
-      - *attach_workspace
-      - run:
-          name: Set cache key
-          command: echo "$FEATURES" > /FEATURES
-      - *restore_cache_cli
-      - run:
-           name: clippy
-           command: cargo clippy --no-default-features --features="${FEATURES}" --release -p plume-cli -- -D warnings
-      - *save_cache_cli
-  - &test_unit
-    steps:
-      - *attach_workspace
-      - run:
-          name: Set cache key
-          command: echo "$FEATURES" > /FEATURES
-      - *restore_cache_plume_dead_code
-      - run:
-          name: clippy
-          command: cargo clippy --no-default-features --features="${FEATURES}" --release -- -D warnings
-      - run:
-          name: compile test
-          command: cargo test --no-default-features --features="${FEATURES}" --all --exclude plume-front --no-run || cargo test --no-default-features --features="${FEATURES}" --all --exclude plume-front --no-run
-      - run:
-          name: run test
-          command: ./script/run_unit_test.sh
-      - run:
-          name: upload coverage
-          command: ./script/upload_coverage.sh unit
-      - *save_cache_plume_dead_code
+    - run: rustup component add clippy --toolchain nightly-2022-07-19-x86_64-unknown-linux-gnu
+    - run: cargo clippy <<^parameters.no_feature>>--no-default-features --features="${FEATURES}"<</parameters.no_feature>> --release -p <<parameters.package>> -- -D warnings
 
-  - &test_browser
+  run_with_coverage:
+    description: run command with environment for coverage
+    parameters:
+      cmd:
+        type: string
     steps:
-      - *attach_workspace
-      - run:
-          name: Set cache key
-          command: echo "$FEATURES" > /FEATURES
-      - *restore_cache_plume_dead_code
-      - run:
-          name: install server
-          command: cargo install --debug --no-default-features --features="${FEATURES}",test --path . --force || cargo install --debug --no-default-features --features="${FEATURES}",test --path . --force
-      - run:
-          name: install plm
-          command: cargo install --debug --no-default-features --features="${FEATURES}" --path plume-cli --force || cargo install --debug --no-default-features --features="${FEATURES}" --path plume-cli --force
-      - run:
-          name: run test
-          command: ./script/run_browser_test.sh
-          environment:
-            BROWSER: firefox
-      - run:
-          name: upload coverage
-          command: ./script/upload_coverage.sh integration
-      - *save_cache_plume_dead_code
+    - run: |
+       export RUSTFLAGS="-Zprofile -Zfewer-names -Ccodegen-units=1 -Cinline-threshold=0 -Clink-dead-code -Coverflow-checks=off -Clink-arg=-Xlinker -Clink-arg=--no-keep-memory -Clink-arg=-Xlinker -Clink-arg=--reduce-memory-overheads"
+       export CARGO_INCREMENTAL=0
+       << parameters.cmd >>
 
-  - &release
+  upload_coverage:
+    description: merge coverage files and upload to codecov.io
+    parameters:
+      type:
+        type: string
     steps:
-      - *attach_workspace
-      - *restore_cache_release
-      - run:
-          name: build frontend
-          command: cargo web deploy -p plume-front --release
-      - run:
-          name: build server
-          command: cargo build --release --no-default-features --features="${FEATURES}" || cargo build --release --no-default-features --features="${FEATURES}"
-      - run:
-          name: build plm
-          command: cargo build --release --no-default-features --features="${FEATURES}" -p plume-cli || cargo build --release --no-default-features --features="${FEATURES}" -p plume-cli
-      - *save_cache_release
-      - run: script/generate_artifact.sh
-      - store_artifacts:
-          path: plume.tar.gz
-          destination: plume.tar.gz
+    - 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 '/*' -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 16 4 2 1 1; do
+                $cmd $i && exit 0
+            done
+            exit 1
 
 jobs:
-  download_deps:
-    <<: *defaults
+  cargo fmt:
+    executor:
+      name: default
     steps:
-      - checkout
-      - *attach_workspace
-      - *restore_cache
-      - run: git config --global --remove-section url."ssh://git@github.com"
-      - run: cargo fetch
-      - *save_cache
-      - *persist_to_workspace
+    - restore_env
+    - run: rustup component add rustfmt --toolchain nightly-2022-07-19-x86_64-unknown-linux-gnu
+    - run: cargo fmt --all -- --check
 
-  cargo_fmt:
-    <<: *defaults
+  clippy:
+    parameters:
+      postgres:
+        type: boolean
+    executor:
+      name: default
+      postgres: << parameters.postgres >>
     steps:
-      - *attach_workspace
-      - run: cargo fmt --all -- --check
+    - restore_env:
+        cache: clippy
+    - clippy
+    - clippy:
+        package: plume-cli
+    - clippy:
+        package: plume-front
+        no_feature: true
+    - cache:
+        cache: clippy
 
-  build_web:
-    <<: *defaults
+  unit:
+    parameters:
+      postgres:
+        type: boolean
+    executor:
+      name: default
+      postgres: << parameters.postgres >>
     steps:
-      - *attach_workspace
-      - *restore_cache_web
-      - run: cargo clippy -p plume-front -- -D warnings
-      - run: cargo web deploy -p plume-front
-      - *save_cache_web
-      - *persist_to_workspace
+    - restore_env:
+        cache: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+    - run_with_coverage:
+        cmd: |
+          cargo build -p plume-cli --no-default-features --features=${FEATURES} -j 4
+          ./target/debug/plm migration run
+          ./target/debug/plm search init
+          cmd="cargo test --all --exclude plume-front --exclude plume-macro --no-run --no-default-features --features=${FEATURES} -j"
+          for i in 16 4 2 1 1; do
+              $cmd $i && break
+          done
+          cargo test --all --exclude plume-front --exclude plume-macro --no-default-features --features="${FEATURES}" -j1
+    - upload_coverage:
+        type: unit
+    - cache:
+        cache: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
 
-  test_cli_postgresql:
-    <<: *postgresql
-    <<: *env_postgresql
-    <<: *test_cli
-
-  test_cli_sqlite:
-    <<: *defaults
-    <<: *env_sqlite
-    <<: *test_cli
-
-  test_unit_postgresql:
-    <<: *postgresql
-    <<: *env_postgresql
-    <<: *test_unit
-
-  test_unit_sqlite:
-    <<: *defaults
-    <<: *env_sqlite
-    <<: *test_unit
-
-  test_browser_postgresql:
-    <<: *postgresql_selenium
-    <<: *env_postgresql
-    <<: *test_browser
-
-  test_browser_sqlite:
-    <<: *selenium
-    <<: *env_sqlite
-    <<: *test_browser
-  all_ok:
-    docker:
-      - image: alpine:3.7
+  integration:
+    parameters:
+      postgres:
+        type: boolean
+    executor:
+      name: default
+      postgres: << parameters.postgres >>
+      selenium: true
     steps:
-      - run: /bin/true
-  release_postgresql:
-    <<: *defaults
-    <<: *env_postgresql
-    <<: *release
-  release_sqlite:
-    <<: *defaults
-    <<: *env_sqlite
-    <<: *release
+    - restore_env:
+        cache: <<#parameters.postgres>>postgres<</ parameters.postgres>><<^parameters.postgres>>sqlite<</parameters.postgres>>
+    - run: wasm-pack build --target web --release plume-front
+    - run_with_coverage:
+        cmd: |
+            cmd="cargo install --debug --no-default-features --features="${FEATURES}",test --force --path . -j"
+            for i in 16 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 16 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: wasm-pack build --target web --release plume-front
+    - 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: cargo build
+    - run: crowdin upload -b master
 
 workflows:
   version: 2
-  build_and_test:
+  build and test:
     jobs:
-      - download_deps
-      - cargo_fmt:
-          requires:
-            - download_deps
-      - build_web:
-          requires:
-            - download_deps
-      - test_cli_postgresql:
-          requires:
-            - download_deps
-      - test_cli_sqlite:
-          requires:
-            - download_deps
-      - test_unit_postgresql:
-          requires:
-            - download_deps
-      - test_unit_sqlite:
-          requires:
-            - download_deps
-      - test_browser_postgresql:
-          requires:
-            - build_web
-      - test_browser_sqlite:
-          requires:
-            - build_web
-      - all_ok:
-          requires:
-            - cargo_fmt
-            - test_cli_postgresql
-            - test_cli_sqlite
-            - test_unit_postgresql
-            - test_unit_sqlite
-            - test_browser_postgresql
-            - test_browser_sqlite
-      - release_postgresql:
-          requires:
-            - all_ok
-      - release_sqlite:
-          requires:
-            - all_ok
+    - 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:
+              - /^main/

.circleci/images/plume-buildenv/Caddyfile

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

.circleci/images/plume-buildenv/Dockerfile

@@ -1,32 +1,31 @@
-FROM debian:stretch-20190326
+FROM rust:1
 ENV PATH="/root/.cargo/bin:${PATH}"
 
 #install native/circleci/build dependancies
 RUN apt update &&\
-    apt install -y git ssh tar gzip ca-certificates &&\
-    apt install -y 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
+    apt install -y --no-install-recommends git ssh tar gzip ca-certificates default-jre&&\
+    echo "deb [trusted=yes] https://apt.fury.io/caddy/ /" \
+    | tee -a /etc/apt/sources.list.d/caddy-fury.list &&\
+    wget -qO - https://artifacts.crowdin.com/repo/GPG-KEY-crowdin | apt-key add - &&\
+    echo "deb https://artifacts.crowdin.com/repo/deb/ /" > /etc/apt/sources.list.d/crowdin.list &&\
+    apt update &&\
+    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-dev python3-pip python3-setuptools zip unzip libclang-dev clang caddy crowdin3 &&\
+    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
+#stick rust environment
+COPY rust-toolchain ./
+RUN rustup component add rustfmt clippy
 
 #compile some deps
-RUN cargo install cargo-web &&\
-    cargo install diesel_cli --no-default-features --features postgres,sqlite --version '=1.3.0' &&\
+RUN cargo install wasm-pack &&\
+    cargo install grcov &&\
     rm -fr ~/.cargo/registry
 
-#install coverage tools
-RUN curl -L https://github.com/SimonKagstrom/kcov/archive/master.tar.gz | tar xz &&\
-    mkdir -p kcov-master/build && cd kcov-master/build && cmake .. && make &&\
-    make install && cd ../.. && rm -rf kcov-master
-
 #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
+#configure caddy
 COPY Caddyfile /Caddyfile

.circleci/images/plume-buildenv/cargo_config

@@ -1,3 +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-dead-code", "-Clink-args=-Xlinker --no-keep-memory -Xlinker --reduce-memory-overheads"]
+rustflags = ["-Clink-args=-Xlinker --no-keep-memory -Xlinker --reduce-memory-overheads"]

.circleci/images/plume-buildenv/rust-toolchain

@@ -0,0 +1 @@
+nightly-2022-07-19

.dockerignore

@@ -3,3 +3,5 @@ data
 Dockerfile
 docker-compose.yml
 .env
+target
+data

.env.sample

@@ -0,0 +1,59 @@
+# This file contains your instance configuration
+# Some documentation about these variables is available here:
+# https://docs.joinplu.me/environment/
+
+## GENERAL SETTINGS ##
+
+# The directory containing database migrations
+# For Postgres: migrations/postgres
+# For SQlite: migrations/sqlite
+MIGRATION_DIRECTORY=migrations/postgres
+
+# The URL of your database (or its path for SQlite databases)
+DATABASE_URL=postgres://plume:plume@localhost/plume
+
+# The domain of your instance
+BASE_URL=plu.me
+
+# Log level for each crate
+RUST_LOG=info
+
+# The secret key for private cookies and CSRF protection
+# You can generate one with `openssl rand -base64 32`
+ROCKET_SECRET_KEY=
+
+# Port and address which Plume will use
+ROCKET_PORT=7878
+ROCKET_ADDRESS=127.0.0.1
+
+## MAIL CONFIG ##
+#MAIL_SERVER=smtp.plu.me
+#MAIL_ADDRESS=no-reply@plu.me
+#MAIL_USER=plume
+#MAIL_PASSWORD=
+#MAIL_HELO_NAME=no-reply@plu.me
+
+## ADVANCED OPTIONS ##
+#MEDIA_UPLOAD_DIRECTORY=static/media
+#SEARCH_INDEX=search_index
+
+# Sample logo configuration
+#PLUME_LOGO=icons/trwnh/paragraphs/plumeParagraphs.svg
+#PLUME_LOGO_FAVICON=icons/trwnh/paragraphs/plumeParagraphs32.png
+#PLUME_LOGO_48=icons/trwnh/paragraphs/plumeParagraphs48.png
+#PLUME_LOGO_72=icons/trwnh/paragraphs/plumeParagraphs72.png
+#PLUME_LOGO_96=icons/trwnh/paragraphs/plumeParagraphs96.png
+#PLUME_LOGO_144=icons/trwnh/paragraphs/plumeParagraphs144.png
+#PLUME_LOGO_160=icons/trwnh/paragraphs/plumeParagraphs160.png
+#PLUME_LOGO_192=icons/trwnh/paragraphs/plumeParagraphs192.png
+#PLUME_LOGO_256=icons/trwnh/paragraphs/plumeParagraphs256.png
+#PLUME_LOGO_512=icons/trwnh/paragraphs/plumeParagraphs512.png
+
+## LDAP CONFIG ##
+# the object that will be bound is "${USER_NAME_ATTR}=${username},${BASE_DN}"
+#LDAP_ADDR=ldap://127.0.0.1:1389
+#LDAP_BASE_DN="ou=users,dc=your-org,dc=eu"
+#LDAP_USER_NAME_ATTR=cn
+#LDAP_USER_MAIL_ATTR=mail
+#LDAP_TLS=false
+

.envrc

@@ -0,0 +1 @@
+use flake

.github/ISSUE_TEMPLATE/bug_report.md

@@ -7,6 +7,16 @@ assignees: ''
 
 ---
 
+<!--
+We would appreciated if you report a bug at our Gitea instance's issue page:
+https://git.joinplu.me/Plume/Plume/issues
+You can login to the Gitea with your GitHub account.
+
+We welcome to receive bug reports here, GitHub, too.
+-->
+
+
+
 <!-- Describe your bug, explaining how to reproduce it, and what was expected -->
 
 

.github/ISSUE_TEMPLATE/feature_request.md

@@ -7,6 +7,15 @@ assignees: ''
 
 ---
 
+<!--
+We would appreciated if you request a feature at our Gitea instance's issue page:
+https://git.joinplu.me/Plume/Plume/issues
+You can login to the Gitea with your GitHub account.
+
+We welcome to receive feature requests here, GitHub, too.
+-->
+
+
 **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 [...]
 

.github/dependabot.yml

@@ -0,0 +1,6 @@
+version: 2
+updates:
+  - package-ecosystem: cargo
+    directory: /
+    schedule:
+      interval: daily

.github/pull_request_template.md

@@ -0,0 +1,7 @@
+<!--
+We would appreciated if you report a bug at our Gitea instance's pull request page:
+https://git.joinplu.me/Plume/Plume/pulls
+You can login to the Gitea with your GitHub account.
+
+We welcome to receive pull requests here, GitHub, too.
+-->

.github/workflows/deploy-docker-latest.yaml

@@ -0,0 +1,30 @@
+name: cd
+
+on:
+  push:
+    branches:
+      - 'main'
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          tags: plumeorg/plume:latest

.github/workflows/deploy-docker-tag.yaml

@@ -0,0 +1,36 @@
+name: cd
+
+on:
+  push:
+    tags:
+      - '*.*.*'
+
+jobs:
+  docker:
+    runs-on: ubuntu-latest
+    steps:
+      -
+        name: Set up QEMU
+        uses: docker/setup-qemu-action@v2
+      -
+        name: Set up Docker Buildx
+        uses: docker/setup-buildx-action@v2
+      -
+        name: Docker meta
+        id: meta
+        uses: docker/metadata-action@v3
+        with:
+          images: plumeorg/plume
+      -
+        name: Login to DockerHub
+        uses: docker/login-action@v2
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+      -
+        name: Build and push
+        id: docker_build
+        uses: docker/build-push-action@v3
+        with:
+          push: true
+          tags: ${{ steps.meta.outputs.tags }}

.gitignore

@@ -7,7 +7,7 @@ translations
 .env
 Rocket.toml
 !.gitkeep
-static/media
+static
 docker-compose.yml
 *.db
 *.sqlite
@@ -16,8 +16,8 @@ docker-compose.yml
 tags.*
 !tags.rs
 search_index
-main.css
-*.wasm
-*.js
 .buildconfig
 __pycache__
+.vscode/
+*-journal
+.direnv/

CHANGELOG.md

@@ -0,0 +1,292 @@
+# Changelog
+
+<!-- next-header -->
+
+## [Unreleased] - ReleaseDate
+
+### Added
+
+- Add 'My feed' to i18n timeline name (#1084)
+- Bidirectional support for user page header (#1092)
+
+### Changed
+
+- Use blog title as slug (#1094, #1126, #1127)
+- Bump Rust to nightly 2022-07-19 (#1119)
+
+### Fixed
+
+- Malfunction while creating a blog post in Persian (#1116)
+- Email block list is ignored when email sign-up (#1122)
+- Bug that some Activity Sytreams properties are not parsed properly (#1129)
+- Allow empty avatar for remote users (#1129)
+- Percent encode blog FQN for federation interoperability (#1129)
+- The same to `preferredUsername` (#1129)
+
+## [[0.7.2]] - 2022-05-11
+
+### Added
+
+- Basque language (#1013)
+- Unit tests for ActivityPub (#1021)
+- Move to action area after liking/boosting/commenting (#1074)
+
+### Changed
+
+- Bump Rust to nightly 2022-01-26 (#1015)
+- Remove "Latest articles" timeline (#1069)
+- Change order of timeline tabs (#1069, #1070, #1072)
+- Migrate ActivityPub-related crates from activitypub 0.1 to activitystreams 0.7 (#1022)
+
+### Fixed
+
+- Add explanation of sign-up step at sign-up page when email sign-up mode (#1012)
+- Add NOT NULL constraint to email_blocklist table fields (#1016)
+- Don't fill empty content when switching rich editor (#1017)
+- Fix accept header (#1058)
+- Render 404 page instead of 500 when data is not found (#1062)
+- Reuse reqwest client on broadcasting (#1059)
+- Reduce broadcasting HTTP request at once to prevent them being timed out (#1068, #1071)
+- Some ActivityPub data (#1021)
+
+## [[0.7.1]] - 2022-01-12
+
+### Added
+
+- Introduce environment variable `MAIL_PORT` (#980)
+- Introduce email sign-up feature (#636, #1002)
+
+### Changed
+
+- Some styling improvements (#976, #977, #978)
+- Respond with error status code when error (#1002)
+
+### Fiexed
+
+- Fix comment link (#974)
+- Fix a bug that prevents posting articles (#975)
+- Fix a bug that notification page doesn't show (#981)
+
+## [[0.7.0]] - 2022-01-02
+
+### Added
+
+- Allow `dir` attributes for LtoR text in RtoL document (#860)
+- More translation languages (#862)
+- Proxy support (#829)
+- Riker a actor system library (#870)
+- (request-target) and Host header in HTTP Signature (#872)
+- Default log levels for RUST_LOG (#885, #886, #919)
+
+### Changed
+
+- Upgrade some dependent crates (#858)
+- Use tracing crate (#868)
+- Update Rust version to nightly-2021-11-27 (#961)
+- Upgrade Tantivy to 0.13.3 and lindera-tantivy to 0.7.1 (#878)
+- Run searcher on actor system (#870)
+- Extract a function to calculate posts' ap_url and share it with some places (#918)
+- Use article title as its slug instead of capitalizing and inserting hyphens (#920)
+- Sign GET requests to other instances (#957)
+
+### Fixed
+
+- Percent-encode URI for remote_interact (#866, #857)
+- Menu animation not opening on iOS (#876, #897)
+- Make actors subscribe to channel once (#913)
+- Upsert posts and media instead of trying to insert and fail (#912)
+- Update post's ActivityPub id when published by update (#915)
+- Calculate media URI properly even when MEDIA_UPLOAD_DIRECTORY configured (#916)
+- Prevent duplicated posts in 'all' timeline (#917)
+- Draw side line for blockquote on start (#933)
+- Fix URIs of posts on Mastodon (#947)
+- Place edit link proper position (#956, #963, #964)
+
+## [[0.6.0]] - 2020-12-29
+
+### Added
+
+- Vazir font for better support of languages written in Arabic script (#787)
+- Login via LDAP (#826)
+- cargo-release (#835)
+- Care about weak ETag header for better caching (#840)
+- Support for right to left languages in post content (#853)
+
+### Changed
+
+- Bump Docker base images to Buster flavor (#797)
+- Upgrade Rocket to 0.4.5 (#800)
+- Keep tags as-is (#832)
+- Update Docker image for testing (#838)
+- Update Dockerfile.dev (#841)
+
+### Fixed
+
+- Recreate search index if its format is outdated (#802)
+- Make it possible to switch to rich text editor (#808)
+- Fix margins for the mobile devices (#817)
+- GPU acceleration for the mobile menu (#818)
+- Natural title position for RtoL languages (#825)
+- Remove link to unimplemented page (#827)
+- Fix displaying not found page when submitting a duplicated blocklist email (#831)
+
+### Security
+
+- Validate spoofing of activity
+
+## [0.5.0] - 2020-06-21
+
+### Added
+
+- Email blocklisting (#718)
+- Syntax highlighting (#691)
+- Persian localization (#782)
+- Switchable tokenizer - enables Japanese full-text search (#776)
+- Make database connections configurable by environment variables (#768)
+
+### Changed
+
+- Display likes and boost on post cards (#744)
+- Rust 2018 (#726)
+- Bump to LLVM to 9.0.0 to fix ARM builds (#737)
+- Remove dependency on runtime-fmt (#773)
+- Drop the -alpha suffix in release names, it is implied that Plume is not stable yet because of the 0 major version (Plume 1.0.0 will be the first stable release).
+
+### Fixed
+
+- Fix parsing of mentions inside a Markdown code block (be430c6)
+- Fix RSS issues (#720)
+- Fix Atom feed (#764)
+- Fix default theme (#746)
+- Fix shown password on remote interact pages (#741)
+- Allow unicode hashtags (#757)
+- Fix French grammar for for 0 (#760)
+- Don't show boosts and likes for "all" and "local" in timelines (#781)
+- Fix liking and boosting posts on remote instances (#762)
+
+## [0.4.0] - 2019-12-23
+
+### Added
+
+- Add support for generic timeline (#525)
+- Federate user deletion (#551)
+- import migrations and don't require diesel_cli for admins (#555)
+- Cache local instance (#572)
+- Initial RTL support #575 (#577)
+- Confirm deletion of blog (#602)
+- Make a distinction between moderators and admins (#619)
+- Theming (#624)
+- Add clap to plume in order to print help and version (#631)
+- Add Snapcraft metadata and install/maintenance hooks (#666)
+- Add environmental variable to control path of media (#683)
+- Add autosaving to the editor (#688)
+- CI: Upload artifacts to pull request deploy environment (#539)
+- CI: Upload artifact of wasm binary (#571)
+
+### Changed
+
+- Update follow_remote.rs.html grammar (#548)
+- Add some feedback when performing some actions (#552)
+- Theme update (#553)
+- Remove the new index lock tantivy uses (#556)
+- Reduce reqwest timeout to 5s (#557)
+- Improve notification management (#561)
+- Fix occurrences of 'have been' to 'has been' (#578) + Direct follow-up to #578 (#603)
+- Store password reset requests in database (#610)
+- Use futures and tokio to send activities (#620)
+- Don't ignore dotenv errors (#630)
+- Replace the input! macro with an Input builder (#646)
+- Update default license (#659)
+- Paginate the outbox responses. Fixes #669 (#681)
+- Use the "classic" editor by default (#697)
+- Fix issue #705 (#708)
+- Make comments in styleshhets a bit clearer (#545)
+- Rewrite circleci config (#558)
+- Use openssl instead of sha256sum for build.rs (#568)
+- Update dependencies (#574)
+- Refactor code to use Shrinkwraprs and diesel-derive-newtype (#598)
+- Add enum containing all successful route returns (#614)
+- Update dependencies which depended on nix -- fixes arm32 builds (#615)
+- Update some documents (#616)
+- Update dependencies (#643)
+- Make the comment syntax consistent across all CSS (#487)
+
+### Fixed
+
+- Remove r (#535)
+- Fix certain improper rendering of forms (#560)
+- make hashtags work in profile summary (#562)
+- Fix some federation issue (#573)
+- Prevent comment form submit button distortion on iOS (#592)
+- Update textarea overflow to scroll (#609)
+- Fix arm builds (#612)
+- Fix theme caching (#647)
+- Fix issue #642, frontend not in English if the user language does not exist (#648)
+- Don't index drafts (#656)
+- Fill entirely user on creation (#657)
+- Delete notification on user deletion (#658)
+- Order media so that latest added are top (#660)
+- Fix logo URL (#664)
+- Snap: Ensure cargo-web doesn't erroneously adopt our workspace. (#667)
+- Snap: Another fix for building (#668)
+- Snap: Fix build for non-Tier-1 Rust platforms (#672)
+- Don't split sentences for translations (#677)
+- Escape href quotation marks (#678)
+- Re-add empty strings in translation (#682)
+- Make the search index creation during migration respect SEARCH_INDEX (#689)
+- Fix the navigation menu not opening on touch (#690)
+- Make search items optional (#693)
+- Various snap fixes (#698)
+- Fix #637 : Markdown footnotes (#700)
+- Fix lettre (#706)
+- CI: Fix Crowdin upload (#576)
+
+### Removed
+
+- Remove the Canapi dependency (#540)
+- Remove use of Rust in migrations (#704)
+
+## [0.3.0] - 2019-04-19
+
+### Added
+
+- Cover for articles (#299, #387)
+- Password reset (#448)
+- New editor (#293, #458, #482, #483, #486, #530)
+- Search (#324, #375, #445)
+- Edit blogs (#460, #494, #497)
+- Hashtags in articles (#283, #295)
+- API endpoints (#245, #285, #307)
+- A bunch of new translations! (#479, #501, #506, #510, #512, #514)
+
+### Changed
+
+- Federation improvements (#216, #217, #357, #364, #399, #443, #446, #455, #502, #519)
+- Improved build process (#281, #374, #392, #402, #489, #498, #503, #511, #513, #515, #528)
+
+### Fixes
+
+- UI usability fixes (#370, #386, #401, #417, #418, #444, #452, #480, #516, #518, #522, #532)
+
+## [0.2.0] - 2018-09-12
+
+### Added
+
+- Article publishing, or save as a draft
+- Like, or boost an article
+- Basic Markdown editor
+- Federated commenting system
+- User account creation
+- Limited federation on other platforms and subscribing to users
+- Ability to create multiple blogs
+
+<!-- next-url -->
+[Unreleased]: https://github.com/Plume-org/Plume/compare/0.7.2...HEAD
+[[0.7.2]]: https://github.com/Plume-org/Plume/compare/0.7.1...0.7.2
+[[0.7.1]]: https://github.com/Plume-org/Plume/compare/0.7.0...0.7.1
+[[0.7.0]]: https://github.com/Plume-org/Plume/compare/0.6.0...0.7.0
+[[0.6.0]]: https://github.com/Plume-org/Plume/compare/0.5.0...0.6.0
+[0.5.0]: https://github.com/Plume-org/Plume/compare/0.4.0-alpha-4...0.5.0
+[0.4.0]: https://github.com/Plume-org/Plume/compare/0.3.0-alpha-2...0.4.0-alpha-4
+[0.3.0]: https://github.com/Plume-org/Plume/compare/0.2.0-alpha-1...0.3.0-alpha-2
+[0.2.0]: https://github.com/Plume-org/Plume/releases/tag/0.2.0-alpha-1

CODE_OF_CONDUCT.md

@@ -1,46 +1,2 @@
-# Contributor Covenant Code of Conduct
-
-## Our Pledge
-
-In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and our community a harassment-free experience for everyone, regardless of age, body size, disability, ethnicity, gender identity and expression, level of experience, nationality, personal appearance, race, religion, sexual identity and orientation, etc.
-
-## Our Standards
-
-Examples of behavior that contributes to creating a positive environment include:
-
-* Using welcoming and inclusive language
-* Being respectful of differing viewpoints and experiences
-* Gracefully accepting constructive criticism
-* Focusing on what is best for the community
-* Showing empathy towards other community members
-
-Examples of unacceptable behavior by participants include:
-
-* The use of sexualized language or imagery and unwelcome sexual attention or advances
-* Trolling, insulting/derogatory comments, and personal or political attacks
-* Public or private harassment
-* Publishing others' private information, such as a physical or electronic address, without explicit permission
-* Other conduct which could reasonably be considered inappropriate in a professional setting
-
-## Our Responsibilities
-
-Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in response to any instances of unacceptable behavior.
-
-Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, or to ban temporarily or permanently any contributor for other behaviors that they deem inappropriate, threatening, offensive, or harmful.
-
-## Scope
-
-This Code of Conduct applies both within project spaces and in public spaces when an individual is representing the project or its community. Examples of representing a project or community include using an official project e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event. Representation of a project may be further defined and clarified by project maintainers.
-
-## Enforcement
-
-Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting the project team at baptiste@gelez.xyz. The project team will review and investigate all complaints, and will respond in a way that it deems appropriate to the circumstances. The project team is obligated to maintain confidentiality with regard to the reporter of an incident. Further details of specific enforcement policies may be posted separately.
-
-Project maintainers who do not follow or enforce the Code of Conduct in good faith may face temporary or permanent repercussions as determined by other members of the project's leadership.
-
-## Attribution
-
-This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, available at [http://contributor-covenant.org/version/1/4][version]
-
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+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,36 +1,33 @@
 [package]
 authors = ["Plume contributors"]
 name = "plume"
-version = "0.3.0"
+version = "0.7.3-dev"
 repository = "https://github.com/Plume-org/Plume"
+edition = "2018"
 
 [dependencies]
-activitypub = "0.1.3"
-askama_escape = "0.1"
-atom_syndication = "0.6"
-canapi = "0.2"
-colored = "1.7"
-dotenv = "0.13"
-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"
-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 = "2.0"
-runtime-fmt = "0.3.0"
-scheduled-thread-pool = "0.2.0"
-serde = "1.0"
-serde_json = "1.0"
-serde_qs = "0.4"
-validator = "0.8"
-validator_derive = "0.8"
-webfinger = "0.3.1"
+atom_syndication = "0.12.0"
+clap = "2.33"
+dotenv = "0.15.0"
+gettext = "0.4.0"
+gettext-macros = "0.6.1"
+gettext-utils = "0.1.0"
+guid-create = "0.2"
+lettre_email = "0.9.2"
+num_cpus = "1.10"
+rocket = "0.4.11"
+rocket_contrib = { version = "0.4.11", features = ["json"] }
+rocket_i18n = "0.4.1"
+scheduled-thread-pool = "0.2.6"
+serde = "1.0.137"
+serde_json = "1.0.81"
+shrinkwraprs = "0.3.0"
+validator = { version = "0.15", features = ["derive"] }
+webfinger = "0.4.1"
+tracing = "0.1.35"
+tracing-subscriber = "0.3.10"
+riker = "0.4.2"
+activitystreams = "=0.7.0-alpha.20"
 
 [[bin]]
 name = "plume"
@@ -42,16 +39,16 @@ version = "0.4"
 
 [dependencies.ctrlc]
 features = ["termination"]
-version = "3.1.1"
+version = "3.2.2"
 
 [dependencies.diesel]
 features = ["r2d2", "chrono"]
-version = "*"
+version = "1.4.5"
 
 [dependencies.multipart]
 default-features = false
 features = ["server"]
-version = "0.16"
+version = "0.18"
 
 [dependencies.plume-api]
 path = "plume-api"
@@ -63,19 +60,21 @@ path = "plume-common"
 path = "plume-models"
 
 [dependencies.rocket_csrf]
-git = "https://github.com/fdb-hiroshima/rocket_csrf"
-rev = "4a72ea2ec716cb0b26188fb00bccf2ef7d1e031c"
+git = "https://git.joinplu.me/plume/rocket_csrf"
+rev = "0.1.2"
 
 [build-dependencies]
-ructe = "0.5.6"
-rsass = "0.9"
+ructe = "0.15.0"
+rsass = "0.26"
 
 [features]
-default = ["postgres"]
+default = ["postgres", "s3"]
 postgres = ["plume-models/postgres", "diesel/postgres"]
 sqlite = ["plume-models/sqlite", "diesel/sqlite"]
 debug-mailer = []
 test = []
+search-lindera = ["plume-models/search-lindera"]
+s3 = ["plume-models/s3"]
 
 [workspace]
-members = ["plume-api", "plume-cli", "plume-models", "plume-common", "plume-front"]
+members = ["plume-api", "plume-cli", "plume-models", "plume-common", "plume-front", "plume-macro"]

Dockerfile

@@ -1,4 +1,4 @@
-FROM rust:1-stretch as builder
+FROM rust:1 as builder
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
     ca-certificates \
@@ -10,25 +10,23 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     gcc \
     make \
     openssl \
-    libssl-dev
+    libssl-dev \
+    clang
 
 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 cargo install wasm-pack
 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
+FROM debian:stable-slim
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
     ca-certificates \
@@ -40,7 +38,6 @@ 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/
-COPY --from=builder /usr/local/cargo/bin/diesel /bin/
 
 CMD ["plume"]
 

Dockerfile.dev

@@ -1,4 +1,4 @@
-FROM rust:1-stretch
+FROM rust:1-buster
 
 RUN apt-get update && apt-get install -y --no-install-recommends \
     ca-certificates \
@@ -10,7 +10,8 @@ RUN apt-get update && apt-get install -y --no-install-recommends \
     gcc \
     make \
     openssl \
-    libssl-dev
+    libssl-dev\
+    clang
 
 WORKDIR /scratch
 COPY script/wasm-deps.sh .
@@ -19,7 +20,7 @@ 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
+RUN cargo install wasm-pack
 
 COPY . .
 

ISSUE_TEMPLATE.md

@@ -1,11 +0,0 @@
-<!--
-If your issue is not purely technical, it should be debated on Loomio first
-
-https://framavox.org/g/WK40YHMA/plume
--->
-
-
-
-
-
-Plume version (and/or commit):

README.md

@@ -1,29 +1,56 @@
 <h1 align="center">
-  <img src="https://raw.githubusercontent.com/Plume-org/Plume/master/static/icons/trwnh/feather/plumeFeather64.png" alt="Plume's logo">
+  <img src="https://raw.githubusercontent.com/Plume-org/Plume/main/assets/icons/trwnh/feather/plumeFeather64.png" alt="Plume's logo">
   Plume
 </h1>
 <p align="center">
-  <a href="https://travis-ci.org/Plume-org/Plume"><img src="https://travis-ci.org/Plume-org/Plume.svg?branch=master" alt="Build status"></a>
-  <a href="hhttps://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 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/main/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://contribute.joinplu.me/">Contribute</a>
+  <a href="https://docs.joinplu.me/contribute">Contribute</a>
   —
   <a href="https://joinplu.me/#instances">Instances list</a>
 </p>
 
-Plume is a 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*.
 
-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.
+## Features
 
-Feel free to join our Matrix room: `#plume:disroot.org` to discuss about the project!
+A lot of features are still missing, but what is already here should be quite stable. Current and planned features include:
 
-We also have a [Loomio group](https://framavox.org/g/WK40YHMA/plume) to debate and vote and features. Feel free to join it to take part in Plume's decision process.
+- **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. (Not implemented yet, but will be in 1.0)
 
-For more informations on the different ways to contribute, check out our [contribution page](https://contribute.joinplu.me). We are welcoming any kind of contribution, and you can probably find a way to help.
+## Get involved
+
+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-blog:matrix.org`](https://matrix.to/#/#plume-blog:matrix.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/).
 
-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://github.com/Plume-org/Plume/blob/master/CODE_OF_CONDUCT.md). Please read it and make sure you accept it before contributing.