@ -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", |
||||
] |
@ -0,0 +1,261 @@ |
||||
version: 2.1 |
||||
|
||||
executors: |
||||
default: |
||||
parameters: |
||||
postgres: |
||||
type: boolean |
||||
default: false |
||||
selenium: |
||||
type: boolean |
||||
default: false |
||||
docker: |
||||
- image: plumeorg/plume-buildenv:v0.4.0 |
||||
- 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>> |
||||
ROCKET_SECRET_KEY: VN5xV1DN7XdpATadOCYcuGeR/dV0hHfgx9mx9TarLdM= |
||||
|
||||
|
||||
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 -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 '/*' -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: |
||||
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: | |
||||
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>> |
||||
|
||||
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: 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: |
||||
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/ |
@ -0,0 +1,3 @@ |
||||
localhost { |
||||
reverse_proxy localhost:7878 |
||||
} |
@ -0,0 +1,39 @@ |
||||
FROM debian:buster-20210208 |
||||
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&&\ |
||||
echo "deb [trusted=yes] https://apt.fury.io/caddy/ /" \ |
||||
| tee -a /etc/apt/sources.list.d/caddy-fury.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-pip zip unzip libclang-dev clang caddy&&\ |
||||
rm -rf /var/lib/apt/lists/* |
||||
|
||||
#install and configure rust |
||||
RUN curl https://sh.rustup.rs -sSf | sh -s -- --default-toolchain nightly-2021-11-27 -y &&\ |
||||
rustup component add rustfmt clippy &&\ |
||||
rustup component add rust-std --target wasm32-unknown-unknown |
||||
|
||||
#compile some deps |
||||
RUN cargo install wasm-pack &&\ |
||||
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 |
||||
|
||||
#configure caddy |
||||
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 |
@ -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 |
@ -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"] |
@ -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 |
@ -0,0 +1,5 @@ |
||||
docs |
||||
data |
||||
Dockerfile |
||||
docker-compose.yml |
||||
.env |
@ -0,0 +1,18 @@ |
||||
root = true |
||||
|
||||
[*] |
||||
end_of_line = lf |
||||
insert_final_newline = true |
||||
trim_trailing_whitespace = true |
||||
|
||||
[*.{js,rs,css,tera,html}] |
||||
charset = utf-8 |
||||
indent_size = 4 |
||||
|
||||
[*.{rs,tera,css,html}] |
||||
indent_style = space |
||||
indent_size = 4 |
||||
|
||||
[*.js] |
||||
indent_style = space |
||||
indent_size = 2 |
@ -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 |
||||
|
@ -0,0 +1,28 @@ |
||||
--- |
||||
name: Bug report |
||||
about: Create a report to help us improve |
||||
title: '' |
||||
labels: 'C: Bug' |
||||
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 --> |
||||
|
||||
|
||||
|
||||
<!-- 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:** |
@ -0,0 +1,29 @@ |
||||
--- |
||||
name: Feature request |
||||
about: Suggest an idea for this project |
||||
title: '' |
||||
labels: '' |
||||
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 [...] |
||||
|
||||
**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. |
@ -0,0 +1,6 @@ |
||||
version: 2 |
||||
updates: |
||||
- package-ecosystem: cargo |
||||
directory: / |
||||
schedule: |
||||
interval: daily |
@ -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. |
||||
--> |
@ -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@v1 |
||||
- |
||||
name: Set up Docker Buildx |
||||
uses: docker/setup-buildx-action@v1 |
||||
- |
||||
name: Login to DockerHub |
||||
uses: docker/login-action@v1 |
||||
with: |
||||
username: ${{ secrets.DOCKERHUB_USERNAME }} |
||||
password: ${{ secrets.DOCKERHUB_TOKEN }} |
||||
- |
||||
name: Build and push |
||||
id: docker_build |
||||
uses: docker/build-push-action@v2 |
||||
with: |
||||
push: true |
||||
tags: plumeorg/plume:latest |
@ -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@v1 |
||||
- |
||||
name: Set up Docker Buildx |
||||
uses: docker/setup-buildx-action@v1 |
||||
- |
||||
name: Docker meta |
||||
id: meta |
||||
uses: docker/metadata-action@v3 |
||||
with: |
||||
images: plumeorg/plume |
||||
- |
||||
name: Login to DockerHub |
||||
uses: docker/login-action@v1 |
||||
with: |
||||
username: ${{ secrets.DOCKERHUB_USERNAME }} |
||||
password: ${{ secrets.DOCKERHUB_TOKEN }} |
||||
- |
||||
name: Build and push |
||||
id: docker_build |
||||
uses: docker/build-push-action@v2 |
||||
with: |
||||
push: true |
||||
tags: ${{ steps.meta.outputs.tags }} |
@ -0,0 +1,22 @@ |
||||
rls |
||||
/target |
||||
**/*.rs.bk |
||||
rls |
||||
translations |
||||
*.po~ |
||||
.env |
||||
Rocket.toml |
||||
!.gitkeep |
||||
static |
||||
docker-compose.yml |
||||
*.db |
||||
*.sqlite |
||||
*.sqlite3 |
||||
*.swp |
||||
tags.* |
||||
!tags.rs |
||||
search_index |
||||
.buildconfig |
||||
__pycache__ |
||||
.vscode/ |
||||
*-journal |
@ -0,0 +1,260 @@ |
||||
# Changelog |
||||
|
||||
<!-- next-header --> |
||||
|
||||
## [Unreleased] - ReleaseDate |
||||
|
||||
### Added |
||||
|
||||
- Basque language (#1013) |
||||
|
||||
### Changed |
||||
|
||||
- Bump Rust to nightly 2022-01-26 (#1015) |
||||
|
||||
### 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) |
||||
|
||||
## [[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.1...HEAD |
||||
[[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 |
@ -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. |
@ -0,0 +1,79 @@ |
||||
[package] |
||||
authors = ["Plume contributors"] |
||||
name = "plume" |
||||
version = "0.7.1" |
||||
repository = "https://github.com/Plume-org/Plume" |
||||
edition = "2018" |
||||
|
||||
[dependencies] |
||||
activitypub = "0.1.3" |
||||
atom_syndication = "0.11.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.6" |
||||
rocket_contrib = { version = "0.4.5", features = ["json"] } |
||||
rocket_i18n = "0.4.1" |
||||
scheduled-thread-pool = "0.2.2" |
||||
serde = "1.0" |
||||
serde_json = "1.0.79" |
||||
shrinkwraprs = "0.3.0" |
||||
validator = { version = "0.14", features = ["derive"] } |
||||
webfinger = "0.4.1" |
||||
tracing = "0.1.32" |
||||
tracing-subscriber = "0.3.9" |
||||
riker = "0.4.2" |
||||
|
||||
[[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 = ["r2d2", "chrono"] |
||||
version = "1.4.5" |
||||
|
||||
[dependencies.multipart] |
||||
default-features = false |
||||
features = ["server"] |
||||
version = "0.18" |
||||
|
||||
[dependencies.plume-api] |
||||
path = "plume-api" |
||||
|
||||
[dependencies.plume-common] |
||||
path = "plume-common" |
||||
|
||||
[dependencies.plume-models] |
||||
path = "plume-models" |
||||
|
||||
[dependencies.rocket_csrf] |
||||
git = "https://github.com/fdb-hiroshima/rocket_csrf" |
||||
rev = "29910f2829e7e590a540da3804336577b48c7b31" |
||||
|
||||
[build-dependencies] |
||||
ructe = "0.14.0" |
||||
rsass = "0.24" |
||||
|
||||
[features] |
||||
default = ["postgres"] |
||||
postgres = ["plume-models/postgres", "diesel/postgres"] |
||||
sqlite = ["plume-models/sqlite", "diesel/sqlite"] |
||||
debug-mailer = [] |
||||
test = [] |
||||
search-lindera = ["plume-models/search-lindera"] |
||||
|
||||
[workspace] |
||||
members = ["plume-api", "plume-cli", "plume-models", "plume-common", "plume-front", "plume-macro"] |
@ -0,0 +1,46 @@ |
||||
FROM rust:1-buster as builder |
||||
|
||||
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 \ |
||||
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 wasm-pack |
||||
|
||||
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 |
||||
|
||||
FROM debian:buster-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 |
@ -0,0 +1,34 @@ |
||||
FROM rust:1-buster |
||||
|
||||
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\ |
||||
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 wasm-pack |
||||
|
||||
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 |
@ -0,0 +1,661 @@ |
||||
GNU AFFERO GENERAL PUBLIC LICENSE |
||||
Version 3, 19 November 2007 |
||||
|
||||
Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/> |
||||
Everyone is permitted to copy and distribute verbatim copies |
||||
of this license document, but changing it is not allowed. |
||||
|
||||
Preamble |
||||
|
||||
The GNU Affero General Public License is a free, copyleft license for |
||||
software and other kinds of works, specifically designed to ensure |
||||
cooperation with the community in the case of network server software. |
||||
|
||||
The licenses for most software and other practical works are designed |
||||
to take away your freedom to share and change the works. By contrast, |
||||
our General Public Licenses are intended to guarantee your freedom to |
||||
share and change all versions of a program--to make sure it remains free |
||||
software for all its users. |
||||
|
||||
When we speak of free software, we are referring to freedom, not |
||||
price. Our General Public Licenses are designed to make sure that you |
||||
have the freedom to distribute copies of free software (and charge for |
||||
them if you wish), that you receive source code or can get it if you |
||||
want it, that you can change the software or use pieces of it in new |
||||
free programs, and that you know you can do these things. |
||||
|
||||
Developers that use our General Public Licenses protect your rights |
||||
with two steps: (1) assert copyright on the software, and (2) offer |
||||
you this License which gives you legal permission to copy, distribute |
||||
and/or modify the software. |
||||
|
||||
A secondary benefit of defending all users' freedom is that |
||||
improvements made in alternate versions of the program, if they |
||||
receive widespread use, become available for other developers to |
||||
incorporate. Many developers of free software are heartened and |
||||
encouraged by the resulting cooperation. However, in the case of |
||||
software used on network servers, this result may fail to come about. |
||||
The GNU General Public License permits making a modified version and |
||||
letting the public access it on a server without ever releasing its |
||||
source code to the public. |
||||
|
||||
The GNU Affero General Public License is designed specifically to |
||||
ensure that, in such cases, the modified source code becomes available |
||||
to the community. It requires the operator of a network server to |
||||
provide the source code of the modified version running there to the |
||||
users of that server. Therefore, public use of a modified version, on |
||||
a publicly accessible server, gives the public access to the source |
||||
code of the modified version. |
||||
|
||||
An older license, called the Affero General Public License and |
||||
published by Affero, was designed to accomplish similar goals. This is |
||||
a different license, not a version of the Affero GPL, but Affero has |
||||
released a new version of the Affero GPL which permits relicensing under |
||||
this license. |
||||
|
||||
The precise terms and conditions for copying, distribution and |
||||
modification follow. |
||||
|
||||
TERMS AND CONDITIONS |
||||
|
||||
0. Definitions. |
||||
|
||||
"This License" refers to version 3 of the GNU Affero General Public License. |
||||
|
||||
"Copyright" also means copyright-like laws that apply to other kinds of |
||||
works, such as semiconductor masks. |
||||
|
||||
"The Program" refers to any copyrightable work licensed under this |
||||
License. Each licensee is addressed as "you". "Licensees" and |
||||
"recipients" may be individuals or organizations. |
||||
|
||||
To "modify" a work means to copy from or adapt all or part of the work |
||||
in a fashion requiring copyright permission, other than the making of an |
||||
exact copy. The resulting work is called a "modified version" of the |
||||
earlier work or a work "based on" the earlier work. |
||||
|
||||
A "covered work" means either the unmodified Program or a work based |
||||
on the Program. |
||||
|
||||
To "propagate" a work means to do anything with it that, without |
||||
permission, would make you directly or secondarily liable for |
||||
infringement under applicable copyright law, except executing it on a |
||||
computer or modifying a private copy. Propagation includes copying, |
||||
distribution (with or without modification), making available to the |
||||
public, and in some countries other activities as well. |
||||
|
||||
To "convey" a work means any kind of propagation that enables other |
||||
parties to make or receive copies. Mere interaction with a user through |
||||
a computer network, with no transfer of a copy, is not conveying. |
||||
|
||||
An interactive user interface displays "Appropriate Legal Notices" |
||||
to the extent that it includes a convenient and prominently visible |
||||
feature that (1) displays an appropriate copyright notice, and (2) |
||||
tells the user that there is no warranty for the work (except to the |
||||
extent that warranties are provided), that licensees may convey the |
||||
work under this License, and how to view a copy of this License. If |
||||
the interface presents a list of user commands or options, such as a |
||||
menu, a prominent item in the list meets this criterion. |
||||
|
||||
1. Source Code. |
||||
|
||||
The "source code" for a work means the preferred form of the work |
||||
for making modifications to it. "Object code" means any non-source |
||||
form of a work. |
||||
|
||||
A "Standard Interface" means an interface that either is an official |
||||
standard defined by a recognized standards body, or, in the case of |
||||
interfaces specified for a particular programming language, one that |
||||
is widely used among developers working in that language. |
||||
|
||||
The "System Libraries" of an executable work include anything, other |
||||
than the work as a whole, that (a) is included in the normal form of |
||||
packaging a Major Component, but which is not part of that Major |
||||
Component, and (b) serves only to enable use of the work with that |
||||
Major Component, or to implement a Standard Interface for which an |
||||
implementation is available to the public in source code form. A |
||||
"Major Component", in this context, means a major essential component |
||||
(kernel, window system, and so on) of the specific operating system |
||||
(if any) on which the executable work runs, or a compiler used to |
||||
produce the work, or an object code interpreter used to run it. |
||||
|
||||
The "Corresponding Source" for a work in object code form means all |
||||
the source code needed to generate, install, and (for an executable |
||||
work) run the object code and to modify the work, including scripts to |
||||
control those activities. However, it does not include the work's |
||||
System Libraries, or general-purpose tools or generally available free |
||||
programs which are used unmodified in performing those activities but |
||||
which are not part of the work. For example, Corresponding Source |
||||
includes interface definition files associated with source files for |
||||
the work, and the source code for shared libraries and dynamically |
||||
linked subprograms that the work is specifically designed to require, |
||||
such as by intimate data communication or control flow between those |
||||
subprograms and other parts of the work. |
||||
|
||||
The Corresponding Source need not include anything that users |
||||
can regenerate automatically from other parts of the Corresponding |
||||
Source. |
||||
|
||||
The Corresponding Source for a work in source code form is that |
||||
same work. |
||||
|
||||
2. Basic Permissions. |
||||
|
||||
All rights granted under this License are granted for the term of |
||||
copyright on the Program, and are irrevocable provided the stated |
||||
conditions are met. This License explicitly affirms your unlimited |
||||
permission to run the unmodified Program. The output from running a |
||||
covered work is covered by this License only if the output, given its |
||||
content, constitutes a covered work. This License acknowledges your |
||||
rights of fair use or other equivalent, as provided by copyright law. |
||||
|
||||
You may make, run and propagate covered works that you do not |
||||
convey, without conditions so long as your license otherwise remains |
||||
in force. You may convey covered works to others for the sole purpose |
||||
of having them make modifications exclusively for you, or provide you |
||||
with facilities for running those works, provided that you comply with |
||||
the terms of this License in conveying all material for which you do |
||||
not control copyright. Those thus making or running the covered works |
||||
for you must do so exclusively on your behalf, under your direction |
||||
and control, on terms that prohibit them from making any copies of |
||||
your copyrighted material outside their relationship with you. |
||||
|
||||
Conveying under any other circumstances is permitted solely under |
||||
the conditions stated below. Sublicensing is not allowed; section 10 |
||||
makes it unnecessary. |
||||
|
||||
3. Protecting Users' Legal Rights From Anti-Circumvention Law. |
||||
|
||||
No covered work shall be deemed part of an effective technological |
||||
measure under any applicable law fulfilling obligations under article |
||||
11 of the WIPO copyright treaty adopted on 20 December 1996, or |
||||
similar laws prohibiting or restricting circumvention of such |
||||
measures. |
||||
|
||||
When you convey a covered work, you waive any legal power to forbid |
||||
circumvention of technological measures to the extent such circumvention |
||||
is effected by exercising rights under this License with respect to |
||||
the covered work, and you disclaim any intention to limit operation or |
||||
modification of the work as a means of enforcing, against the work's |
||||
users, your or third parties' legal rights to forbid circumvention of |
||||
technological measures. |
||||
|
||||
4. Conveying Verbatim Copies. |
||||
|
||||
You may convey verbatim copies of the Program's source code as you |
||||
receive it, in any medium, provided that you conspicuously and |
||||
appropriately publish on each copy an appropriate copyright notice; |
||||
keep intact all notices stating that this License and any |
||||
non-permissive terms added in accord with section 7 apply to the code; |
||||
keep intact all notices of the absence of any warranty; and give all |
||||
recipients a copy of this License along with the Program. |
||||
|
||||
You may charge any price or no price for each copy that you convey, |
||||
and you may offer support or warranty protection for a fee. |
||||
|
||||
5. Conveying Modified Source Versions. |
||||
|
||||
You may convey a work based on the Program, or the modifications to |
||||
produce it from the Program, in the form of source code under the |
||||
terms of section 4, provided that you also meet all of these conditions: |
||||
|
||||
a) The work must carry prominent notices stating that you modified |
||||
it, and giving a relevant date. |
||||
|
||||
b) The work must carry prominent notices stating that it is |
||||
released under this License and any conditions added under section |
||||
7. This requirement modifies the requirement in section 4 to |
||||
"keep intact all notices". |
||||
|
||||
c) You must license the entire work, as a whole, under this |
||||
License to anyone who comes into possession of a copy. This |
||||
License will therefore apply, along with any applicable section 7 |
||||
additional terms, to the whole of the work, and all its parts, |
||||
regardless of how they are packaged. This License gives no |
||||
permission to license the work in any other way, but it does not |
||||
invalidate such permission if you have separately received it. |
||||
|
||||
d) If the work has interactive user interfaces, each must display |
||||
Appropriate Legal Notices; however, if the Program has interactive |
||||
interfaces that do not display Appropriate Legal Notices, your |
||||
work need not make them do so. |
||||
|
||||
A compilation of a covered work with other separate and independent |
||||
works, which are not by their nature extensions of the covered work, |
||||
and which are not combined with it such as to form a larger program, |
||||
in or on a volume of a storage or distribution medium, is called an |
||||
"aggregate" if the compilation and its resulting copyright are not |
||||
used to limit the access or legal rights of the compilation's users |
||||
beyond what the individual works permit. Inclusion of a covered work |
||||
in an aggregate does not cause this License to apply to the other |
||||
parts of the aggregate. |
||||
|
||||
6. Conveying Non-Source Forms. |
||||
|
||||
You may convey a covered work in object code form under the terms |
||||
of sections 4 and 5, provided that you also convey the |
||||
machine-readable Corresponding Source under the terms of this License, |
||||
in one of these ways: |
||||
|
||||
a) Convey the object code in, or embodied in, a physical product |
||||
(including a physical distribution medium), accompanied by the |
||||
Corresponding Source fixed on a durable physical medium |
||||
customarily used for software interchange. |
||||
|
||||
b) Convey the object code in, or embodied in, a physical product |
||||
(including a physical distribution medium), accompanied by a |
||||
written offer, valid for at least three years and valid for as |
||||
long as you offer spare parts or customer support for that product |
||||
model, to give anyone who possesses the object code either (1) a |
||||
copy of the Corresponding Source for all the software in the |
||||
product that is covered by this License, on a durable physical |
||||
medium customarily used for software interchange, for a price no |
||||
more than your reasonable cost of physically performing this |
||||
conveying of source, or (2) access to copy the |
||||
Corresponding Source from a network server at no charge. |
||||
|
||||
c) Convey individual copies of the object code with a copy of the |
||||
written offer to provide the Corresponding Source. This |
||||
alternative is allowed only occasionally and noncommercially, and |
||||
only if you received the object code with such an offer, in accord |
||||
with subsection 6b. |
||||
|
||||
d) Convey the object code by offering access from a designated |
||||
place (gratis or for a charge), and offer equivalent access to the |
||||
Corresponding Source in the same way through the same place at no |
||||
further charge. You need not require recipients to copy the |
||||
Corresponding Source along with the object code. If the place to |
||||
copy the object code is a network server, the Corresponding Source |
||||
may be on a different server (operated by you or a third party) |
||||
that supports equivalent copying facilities, provided you maintain |
||||
clear directions next to the object code saying where to find the |
||||
Corresponding Source. Regardless of what server hosts the |
||||
Corresponding Source, you remain obligated to ensure that it is |
||||
available for as long as needed to satisfy these requirements. |
||||
|
||||
e) Convey the object code using peer-to-peer transmission, provided |
||||
you inform other peers where the object code and Corresponding |
||||
Source of the work are being offered to the general public at no |
||||
charge under subsection 6d. |
||||
|
||||
A separable portion of the object code, whose source code is excluded |
||||
from the Corresponding Source as a System Library, need not be |
||||
included in conveying the object code work. |
||||
|
||||
A "User Product" is either (1) a "consumer product", which means any |
||||
tangible personal property which is normally used for personal, family, |
||||
or household purposes, or (2) anything designed or sold for incorporation |
||||
into a dwelling. In determining whether a product is a consumer product, |
||||
doubtful cases shall be resolved in favor of coverage. For a particular |
||||
product received by a particular user, "normally used" refers to a |
||||
typical or common use of that class of product, regardless of the status |
||||
of the particular user or of the way in which the particular user |
||||
actually uses, or expects or is expected to use, the product. A product |
||||
is a consumer product regardless of whether the product has substantial |
||||
commercial, industrial or non-consumer uses, unless such uses represent |
||||
the only significant mode of use of the product. |
||||
|
||||
"Installation Information" for a User Product means any methods, |
||||
procedures, authorization keys, or other information required to install |
||||
and execute modified versions of a covered work in that User Product from |
||||
a modified version of its Corresponding Source. The information must |
||||
suffice to ensure that the continued functioning of the modified object |
||||
code is in no case prevented or interfered with solely because |
||||
modification has been made. |
||||
|
||||
If you convey an object code work under this section in, or with, or |
||||
specifically for use in, a User Product, and the conveying occurs as |
||||
part of a transaction in which the right of possession and use of the |
||||
User Product is transferred to the recipient in perpetuity or for a |
||||
fixed term (regardless of how the transaction is characterized), the |
||||
Corresponding Source conveyed under this section must be accompanied |
||||
by the Installation Information. But this requirement does not apply |
||||
if neither you nor any third party retains the ability to install |
||||
modified object code on the User Product (for example, the work has |
||||
been installed in ROM). |
||||
|
||||
The requirement to provide Installation Information does not include a |
||||
requirement to continue to provide support service, warranty, or updates |
||||
for a work that has been modified or installed by the recipient, or for |
||||
the User Product in which it has been modified or installed. Access to a |
||||
network may be denied when the modification itself materially and |
||||
adversely affects the operation of the network or violates the rules and |
||||
protocols for communication across the network. |
||||
|
||||
Corresponding Source conveyed, and Installation Information provided, |
||||
in accord with this section must be in a format that is publicly |
||||
documented (and with an implementation available to the public in |
||||
source code form), and must require no special password or key for |
||||
unpacking, reading or copying. |
||||
|
||||
7. Additional Terms. |
||||
|
||||
"Additional permissions" are terms that supplement the terms of this |
||||
License by making exceptions from one or more of its conditions. |
||||
Additional permissions that are applicable to the entire Program shall |
||||
be treated as though they were included in this License, to the extent |
||||
that they are valid under applicable law. If additional permissions |
||||
apply only to part of the Program, that part may be used separately |
||||
under those permissions, but the entire Program remains governed by |
||||
this License without regard to the additional permissions. |
||||
|
||||
When you convey a copy of a covered work, you may at your option |
||||
remove any additional permissions from that copy, or from any part of |
||||
it. (Additional permissions may be written to require their own |
||||
removal in certain cases when you modify the work.) You may place |
||||
additional permissions on material, added by you to a covered work, |
||||
for which you have or can give appropriate copyright permission. |
||||
|
||||
Notwithstanding any other provision of this License, for material you |
||||
add to a covered work, you may (if authorized by the copyright holders of |
||||
that material) supplement the terms of this License with terms: |
||||
|
||||
a) Disclaiming warranty or limiting liability differently from the |
||||
terms of sections 15 and 16 of this License; or |
||||
|
||||
b) Requiring preservation of specified reasonable legal notices or |
||||
author attributions in that material or in the Appropriate Legal |
||||
Notices displayed by works containing it; or |
||||
|
||||
c) Prohibiting misrepresentation of the origin of that material, or |
||||
requiring that modified versions of such material be marked in |
||||
reasonable ways as different from the original version; or |
||||
|
||||
d) Limiting the use for publicity purposes of names of licensors or |
||||
authors of the material; or |
||||
|
||||
e) Declining to grant rights under trademark law for use of some |
||||
trade names, trademarks, or service marks; or |
||||
|
||||
f) Requiring indemnification of licensors and authors of that |
||||
material by anyone who conveys the material (or modified versions of |
||||
it) with contractual assumptions of liability to the recipient, for |
||||
any liability that these contractual assumptions directly impose on |
||||
those licensors and authors. |
||||
|
||||
All other non-permissive additional terms are considered "further |
||||
restrictions" within the meaning of section 10. If the Program as you |
||||
received it, or any part of it, contains a notice stating that it is |
||||
governed by this License along with a term that is a further |
||||
restriction, you may remove that term. If a license document contains |
||||
a further restriction but permits relicensing or conveying under this |
||||
License, you may add to a covered work material governed by the terms |
||||
of that license document, provided that the further restriction does |
||||
not survive such relicensing or conveying. |
||||
|
||||
If you add terms to a covered work in accord with this section, you |
||||
must place, in the relevant source files, a statement of the |
||||
additional terms that apply to those files, or a notice indicating |
||||
where to find the applicable terms. |
||||
|
||||
Additional terms, permissive or non-permissive, may be stated in the |
||||
form of a separately written license, or stated as exceptions; |
||||
the above requirements apply either way. |
||||
|
||||
8. Termination. |
||||
|
||||
You may not propagate or modify a covered work except as expressly |
||||
provided under this License. Any attempt otherwise to propagate or |
||||
modify it is void, and will automatically terminate your rights under |
||||
this License (including any patent licenses granted under the third |
||||
paragraph of section 11). |
||||
|
||||
However, if you cease all violation of this License, then your |
||||
license from a particular copyright holder is reinstated (a) |
||||
provisionally, unless and until the copyright holder explicitly and |
||||
finally terminates your license, and (b) permanently, if the copyright |
||||
holder fails to notify you of the violation by some reasonable means |
||||
prior to 60 days after the cessation. |
||||
|
||||
Moreover, your license from a particular copyright holder is |
||||
reinstated permanently if the copyright holder notifies you of the |
||||
violation by some reasonable means, this is the first time you have |
||||
received notice of violation of this License (for any work) from that |
||||
copyright holder, and you cure the violation prior to 30 days after |
||||
your receipt of the notice. |
||||
|
||||
Termination of your rights under this section does not terminate the |
||||
licenses of parties who have received copies or rights from you under |
||||
this License. If your rights have been terminated and not permanently |
||||
reinstated, you do not qualify to receive new licenses for the same |
||||
material under section 10. |
||||
|
||||
9. Acceptance Not Required for Having Copies. |
||||
|
||||
You are not required to accept this License in order to receive or |
||||
run a copy of the Program. Ancillary propagation of a covered work |
||||
occurring solely as a consequence of using peer-to-peer transmission |
||||
to receive a copy likewise does not require acceptance. However, |
||||
nothing other than this License grants you permission to propagate or |
||||
modify any covered work. These actions infringe copyright if you do |
||||
not accept this License. Therefore, by modifying or propagating a |
||||
covered work, you indicate your acceptance of this License to do so. |
||||
|
||||
10. Automatic Licensing of Downstream Recipients. |
||||
|
||||
Each time you convey a covered work, the recipient automatically |
||||
receives a license from the original licensors, to run, modify and |
||||
propagate that work, subject to this License. You are not responsible |
||||
for enforcing compliance by third parties with this License. |
||||
|
||||
An "entity transaction" is a transaction transferring control of an |
||||
organization, or substantially all assets of one, or subdividing an |
||||
organization, or merging organizations. If propagation of a covered |
||||
work results from an entity transaction, each party to that |
||||
transaction who receives a copy of the work also receives whatever |
||||
licenses to the work the party's predecessor in interest had or could |
||||
give under the previous paragraph, plus a right to possession of the |
||||
Corresponding Source of the work from the predecessor in interest, if |
||||
the predecessor has it or can get it with reasonable efforts. |
||||
|
||||
You may not impose any further restrictions on the exercise of the |
||||
rights granted or affirmed under this License. For example, you may |
||||
not impose a license fee, royalty, or other charge for exercise of |
||||
rights granted under this License, and you may not initiate litigation |
||||
(including a cross-claim or counterclaim in a lawsuit) alleging that |
||||
any patent claim is infringed by making, using, selling, offering for |
||||
sale, or importing the Program or any portion of it. |
||||
|
||||
11. Patents. |
||||
|
||||
A "contributor" is a copyright holder who authorizes use under this |
||||
License of the Program or a work on which the Program is based. The |
||||
work thus licensed is called the contributor's "contributor version". |
||||
|
||||
A contributor's "essential patent claims" are all patent claims |
||||
owned or controlled by the contributor, whether already acquired or |
||||
hereafter acquired, that would be infringed by some manner, permitted |
||||
by this License, of making, using, or selling its contributor version, |
||||
but do not include claims that would be infringed only as a |
||||
consequence of further modification of the contributor version. For |
||||
purposes of this definition, "control" includes the right to grant |
||||
patent sublicenses in a manner consistent with the requirements of |
||||
this License. |
||||
|
||||
Each contributor grants you a non-exclusive, worldwide, royalty-free |
||||
patent license under the contributor's essential patent claims, to |
||||
make, use, sell, offer for sale, import and otherwise run, modify and |
||||
propagate the contents of its contributor version. |
||||
|
||||
In the following three paragraphs, a "patent license" is any express |
||||
agreement or commitment, however denominated, not to enforce a patent |
||||
(such as an express permission to practice a patent or covenant not to |
||||
sue for patent infringement). To "grant" such a patent license to a |
||||
party means to make such an agreement or commitment not to enforce a |
||||
patent against the party. |
||||
|
||||
If you convey a covered work, knowingly relying on a patent license, |
||||
and the Corresponding Source of the work is not available for anyone |
||||
to copy, free of charge and under the terms of this License, through a |
||||
publicly available network server or other readily accessible means, |
||||
then you must either (1) cause the Corresponding Source to be so |
||||
available, or (2) arrange to deprive yourself of the benefit of the |
||||
patent license for this particular work, or (3) arrange, in a manner |
||||
consistent with the requirements of this License, to extend the patent |
||||
license to downstream recipients. "Knowingly relying" means you have |
||||
actual knowledge that, but for the patent license, your conveying the |
||||
covered work in a country, or your recipient's use of the covered work |
||||
in a country, would infringe one or more identifiable patents in that |
||||
country that you have reason to believe are valid. |
||||
|
||||
If, pursuant to or in connection with a single transaction or |
||||
arrangement, you convey, or propagate by procuring conveyance of, a |
||||
covered work, and grant a patent license to some of the parties |
||||
receiving the covered work authorizing them to use, propagate, modify |
||||
or convey a specific copy of the covered work, then the patent license |
||||
you grant is automatically extended to all recipients of the covered |
||||
work and works based on it. |
||||
|
||||
A patent license is "discriminatory" if it does not include within |
||||
the scope of its coverage, prohibits the exercise of, or is |
||||
conditioned on the non-exercise of one or more of the rights that are |
||||
specifically granted under this License. You may not convey a covered |
||||
work if you are a party to an arrangement with a third party that is |
||||
in the business of distributing software, under which you make payment |
||||
to the third party based on the extent of your activity of conveying |
||||
the work, and under which the third party grants, to any of the |
||||
parties who would receive the covered work from you, a discriminatory |
||||
patent license (a) in connection with copies of the covered work |
||||
conveyed by you (or copies made from those copies), or (b) primarily |
||||
for and in connection with specific products or compilations that |
||||
contain the covered work, unless you entered into that arrangement, |
||||
or that patent license was granted, prior to 28 March 2007. |
||||
|
||||
Nothing in this License shall be construed as excluding or limiting |
||||
any implied license or other defenses to infringement that may |
||||
otherwise be available to you under applicable patent law. |
||||
|
||||
12. No Surrender of Others' Freedom. |
||||
|
||||
If conditions are imposed on you (whether by court order, agreement or |
||||
otherwise) that contradict the conditions of this License, they do not |
||||
excuse you from the conditions of this License. If you cannot convey a |
||||
covered work so as to satisfy simultaneously your obligations under this |
||||
License and any other pertinent obligations, then as a consequence you may |
||||
not convey it at all. For example, if you agree to terms that obligate you |
||||
to collect a royalty for further conveying from those to whom you convey |
||||
the Program, the only way you could satisfy both those terms and this |
||||
License would be to refrain entirely from conveying the Program. |
||||
|
||||
13. Remote Network Interaction; Use with the GNU General Public License. |
||||
|
||||
Notwithstanding any other provision of this License, if you modify the |
||||
Program, your modified version must prominently offer all users |
||||
interacting with it remotely through a computer network (if your version |
||||
supports such interaction) an opportunity to receive the Corresponding |
||||
Source of your version by providing access to the Corresponding Source |
||||
from a network server at no charge, through some standard or customary |
||||
means of facilitating copying of software. This Corresponding Source |
||||
shall include the Corresponding Source for any work covered by version 3 |
||||
of the GNU General Public License that is incorporated pursuant to the |
||||
following paragraph. |
||||
|
||||
Notwithstanding any other provision of this License, you have |
||||
permission to link or combine any covered work with a work licensed |
||||
under version 3 of the GNU General Public License into a single |
||||
combined work, and to convey the resulting work. The terms of this |
||||
License will continue to apply to the part which is the covered work, |
||||
but the work with which it is combined will remain governed by version |
||||
3 of the GNU General Public License. |
||||
|
||||
14. Revised Versions of this License. |
||||
|
||||
The Free Software Foundation may publish revised and/or new versions of |
||||
the GNU Affero General Public License from time to time. Such new versions |
||||
will be similar in spirit to the present version, but may differ in detail to |
||||
address new problems or concerns. |
||||
|
||||
Each version is given a distinguishing version number. If the |
||||
Program specifies that a certain numbered version of the GNU Affero General |
||||
Public License "or any later version" applies to it, you have the |
||||
option of following the terms and conditions either of that numbered |
||||
version or of any later version published by the Free Software |
||||
Foundation. If the Program does not specify a version number of the |
||||
GNU Affero General Public License, you may choose any version ever published |
||||
by the Free Software Foundation. |
||||
|
||||
If the Program specifies that a proxy can decide which future |
||||
versions of the GNU Affero General Public License can be used, that proxy's |
||||
public statement of acceptance of a version permanently authorizes you |
||||
to choose that version for the Program. |
||||
|
||||
Later license versions may give you additional or different |
||||
permissions. However, no additional obligations are imposed on any |
||||
author or copyright holder as a result of your choosing to follow a |
||||
later version. |
||||
|
||||
15. Disclaimer of Warranty. |
||||
|
||||
THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY |
||||
APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT |
||||
HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY |
||||
OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, |
||||
THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR |
||||
PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM |
||||
IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF |
||||
ALL NECESSARY SERVICING, REPAIR OR CORRECTION. |
||||
|
||||
16. Limitation of Liability. |
||||
|
||||
IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING |
||||
WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS |
||||
THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY |
||||
GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE |
||||
USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF |
||||
DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD |
||||
PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), |
||||
EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF |
||||
SUCH DAMAGES. |
||||
|
||||
17. Interpretation of Sections 15 and 16. |
||||
|
||||
If the disclaimer of warranty and limitation of liability provided |
||||
above cannot be given local legal effect according to their terms, |
||||
reviewing courts shall apply local law that most closely approximates |
||||
an absolute waiver of all civil liability in connection with the |
||||
Program, unless a warranty or assumption of liability accompanies a |
||||
copy of the Program in return for a fee. |
||||
|
||||
END OF TERMS AND CONDITIONS |
||||
|
||||
How to Apply These Terms to Your New Programs |
||||
|
||||
If you develop a new program, and you want it to be of the greatest |
||||
possible use to the public, the best way to achieve this is to make it |
||||
free software which everyone can redistribute and change under these terms. |
||||
|
||||
To do so, attach the following notices to the program. It is safest |
||||
to attach them to the start of each source file to most effectively |
||||
state the exclusion of warranty; and each file should have at least |
||||
the "copyright" line and a pointer to where the full notice is found. |
||||
|
||||
<one line to give the program's name and a brief idea of what it does.> |
||||
Copyright (C) <year> <name of author> |
||||
|
||||
This program is free software: you can redistribute it and/or modify |
||||
it under the terms of the GNU Affero General Public License as published by |
||||
the Free Software Foundation, either version 3 of the License, or |
||||
(at your option) any later version. |
||||
|
||||
This program is distributed in the hope that it will be useful, |
||||
but WITHOUT ANY WARRANTY; without even the implied warranty of |
||||
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
||||
GNU Affero General Public License for more details. |
||||
|
||||
You should have received a copy of the GNU Affero General Public License |
||||
along with this program. If not, see <https://www.gnu.org/licenses/>. |
||||
|
||||
Also add information on how to contact you by electronic and paper mail. |
||||
|
||||
If your software can interact with users remotely through a computer |
||||
network, you should also make sure that it provides a way for users to |
||||
get its source. For example, if your program is a web application, its |
||||
interface could display a "Source" link that leads users to an archive |
||||
of the code. There are many ways you could offer source, and different |
||||
solutions will be better for different programs; see section 13 for the |
||||
specific requirements. |
||||
|
||||
You should also get your employer (if you work as a programmer) or school, |
||||
if any, to sign a "copyright disclaimer" for the program, if necessary. |
||||
For more information on this, and how to apply and follow the GNU AGPL, see |
||||
<https://www.gnu.org/licenses/>. |
@ -0,0 +1,55 @@ |
||||
<h1 align="center"> |
||||
<img src="https://raw.githubusercontent.com/Plume-org/Plume/master/assets/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> |
||||
|
||||
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*. |
||||
|
||||
## Features |
||||
|
||||
A lot of features are still missing, but what is already here should be quite stable. Current and planned features include: |
||||
|
||||
- **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) |
||||
|
||||
## 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/). |
@ -0,0 +1,21 @@ |
||||
# plumeLogos |
||||
Logos designed for Plume, a federated blogging platform similar to Medium. Licensed under CC0. |
||||
|
||||
# 1st place design - "Feather" |
||||
Path | Filled | Silhouette |
||||
--- | --- | --- |
||||
![plumeFeather](https://raw.githubusercontent.com/trwnh/plumeLogos/master/plumeFeather/plumeFeather512.png) | ![plumeFeatherFilled](https://raw.githubusercontent.com/trwnh/plumeLogos/master/plumeFeatherFilled/plumeFeatherFilled512.png) | ![plumeFeatherBlack](https://raw.githubusercontent.com/trwnh/plumeLogos/master/plumeFeatherBlack/plumeFeatherBlack512.png) |
||||
|
||||
# 2nd place design - "Paragraphs" |
||||
Filled | Silhouette |
||||
--- | --- |
||||
![plumeParagraphs](https://raw.githubusercontent.com/trwnh/plumeLogos/master/plumeParagraphs/plumeParagraphs512.png) | ![plumeParagraphsBlack](https://raw.githubusercontent.com/trwnh/plumeLogos/master/plumeParagraphsBlack/plumeParagraphsBlack512.png) |
||||
|
||||
# Links |
||||
You may find me at the following locations: |
||||
- Website: http://trwnh.com |
||||
- ActivityPub: https://mastodon.social/@trwnh |
||||
|
||||
If you'd like to support me, you can do so: |
||||
- One-time: https://paypal.me/trwnh |
||||
- Recurring: https://liberapay.com/trwnh |
After Width: | Height: | Size: 18 KiB |
After Width: | Height: | Size: 3.7 KiB |
After Width: | Height: | Size: 17 KiB |
After Width: | Height: | Size: 3.6 KiB |
After Width: | Height: | Size: 2.1 KiB |
After Width: | Height: | Size: 2.5 KiB |
After Width: | Height: | Size: 352 B |
After Width: | Height: | Size: 2.7 KiB |
After Width: | Height: | Size: 3.3 KiB |
After Width: | Height: | Size: 462 B |
After Width: | Height: | Size: 4.7 KiB |
After Width: | Height: | Size: 571 B |
After Width: | Height: | Size: 612 B |
After Width: | Height: | Size: 711 B |
After Width: | Height: | Size: 820 B |
After Width: | Height: | Size: 11 KiB |
After Width: | Height: | Size: 1.0 KiB |
After Width: | Height: | Size: 1.2 KiB |
After Width: | Height: | Size: 1.3 KiB |
After Width: | Height: | Size: 1.6 KiB |
After Width: | Height: | Size: 3.6 KiB |
After Width: | Height: | Size: 5.5 KiB |
After Width: | Height: | Size: 6.2 KiB |
After Width: | Height: | Size: 618 B |
After Width: | Height: | Size: 7.0 KiB |
After Width: | Height: | Size: 8.4 KiB |
After Width: | Height: | Size: 942 B |
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 1.2 KiB |
After Width: | Height: | Size: 1.4 KiB |
After Width: | Height: | Size: 1.8 KiB |
After Width: | Height: | Size: 2.0 KiB |
After Width: | Height: | Size: 24 KiB |
After Width: | Height: | Size: 2.6 KiB |
After Width: | Height: | Size: 3.0 KiB |
After Width: | Height: | Size: 3.4 KiB |
After Width: | Height: | Size: 4.1 KiB |
After Width: | Height: | Size: 3.4 KiB |
After Width: | Height: | Size: 5.7 KiB |
After Width: | Height: | Size: 6.4 KiB |
After Width: | Height: | Size: 562 B |
After Width: | Height: | Size: 7.2 KiB |
After Width: | Height: | Size: 8.8 KiB |
After Width: | Height: | Size: 905 B |
After Width: | Height: | Size: 12 KiB |
After Width: | Height: | Size: 1.2 KiB |
After Width: | Height: | Size: 1.4 KiB |
After Width: | Height: | Size: 1.8 KiB |
After Width: | Height: | Size: 2.0 KiB |
After Width: | Height: | Size: 26 KiB |
After Width: | Height: | Size: 2.7 KiB |
After Width: | Height: | Size: 3.1 KiB |
After Width: | Height: | Size: 3.5 KiB |
After Width: | Height: | Size: 4.2 KiB |
After Width: | Height: | Size: 52 KiB |
After Width: | Height: | Size: 3.6 KiB |
After Width: | Height: | Size: 1.2 KiB |
After Width: | Height: | Size: 1.4 KiB |
After Width: | Height: | Size: 358 B |
After Width: | Height: | Size: 1.5 KiB |
After Width: | Height: | Size: 1.7 KiB |
After Width: | Height: | Size: 432 B |
After Width: | Height: | Size: 2.8 KiB |
After Width: | Height: | Size: 501 B |
After Width: | Height: | Size: 516 B |
After Width: | Height: | Size: 575 B |
After Width: | Height: | Size: 5.8 KiB |
After Width: | Height: | Size: 728 B |
After Width: | Height: | Size: 797 B |
After Width: | Height: | Size: 851 B |
After Width: | Height: | Size: 916 B |
After Width: | Height: | Size: 4.3 KiB |
After Width: | Height: | Size: 1.6 KiB |
After Width: | Height: | Size: 1.9 KiB |