Add README.md for Fedibird, and modify settings
This commit is contained in:
noellabo
parent
9292a6d2c8
commit
ba2953bc9d
9 changed files with 42 additions and 129 deletions
32
.github/CODEOWNERS
vendored
32
.github/CODEOWNERS
vendored
|
|
@ -1,32 +0,0 @@
|
||||||
# CODEOWNERS for mastodon/mastodon
|
|
||||||
|
|
||||||
# Translators
|
|
||||||
# To add translator, copy these lines, replace `fr` with appropriate language code and replace `@żelipapą` with user's GitHub nickname preceded by `@` sign or e-mail address.
|
|
||||||
# /app/javascript/mastodon/locales/fr.json @żelipapą
|
|
||||||
# /app/views/user_mailer/*.fr.html.erb @żelipapą
|
|
||||||
# /app/views/user_mailer/*.fr.text.erb @żelipapą
|
|
||||||
# /config/locales/*.fr.yml @żelipapą
|
|
||||||
# /config/locales/fr.yml @żelipapą
|
|
||||||
|
|
||||||
# Polish
|
|
||||||
/app/javascript/mastodon/locales/pl.json @m4sk1n
|
|
||||||
/app/views/user_mailer/*.pl.html.erb @m4sk1n
|
|
||||||
/app/views/user_mailer/*.pl.text.erb @m4sk1n
|
|
||||||
/config/locales/*.pl.yml @m4sk1n
|
|
||||||
/config/locales/pl.yml @m4sk1n
|
|
||||||
|
|
||||||
# French
|
|
||||||
/app/javascript/mastodon/locales/fr.json @aldarone
|
|
||||||
/app/javascript/mastodon/locales/whitelist_fr.json @aldarone
|
|
||||||
/app/views/user_mailer/*.fr.html.erb @aldarone
|
|
||||||
/app/views/user_mailer/*.fr.text.erb @aldarone
|
|
||||||
/config/locales/*.fr.yml @aldarone
|
|
||||||
/config/locales/fr.yml @aldarone
|
|
||||||
|
|
||||||
# Dutch
|
|
||||||
/app/javascript/mastodon/locales/nl.json @jeroenpraat
|
|
||||||
/app/javascript/mastodon/locales/whitelist_nl.json @jeroenpraat
|
|
||||||
/app/views/user_mailer/*.nl.html.erb @jeroenpraat
|
|
||||||
/app/views/user_mailer/*.nl.text.erb @jeroenpraat
|
|
||||||
/config/locales/*.nl.yml @jeroenpraat
|
|
||||||
/config/locales/nl.yml @jeroenpraat
|
|
||||||
4
.github/FUNDING.yml
vendored
4
.github/FUNDING.yml
vendored
|
|
@ -1,3 +1 @@
|
||||||
patreon: mastodon
|
open_collective: fedibird-project
|
||||||
open_collective: mastodon
|
|
||||||
github: [Gargron]
|
|
||||||
|
|
|
||||||
4
.github/ISSUE_TEMPLATE/3.support.md
vendored
4
.github/ISSUE_TEMPLATE/3.support.md
vendored
|
|
@ -6,5 +6,5 @@ title: DO NOT CREATE THIS ISSUE
|
||||||
|
|
||||||
We primarily use GitHub as a bug and feature tracker. For usage questions, troubleshooting of deployments and other individual technical assistance, please use one of the resources below:
|
We primarily use GitHub as a bug and feature tracker. For usage questions, troubleshooting of deployments and other individual technical assistance, please use one of the resources below:
|
||||||
|
|
||||||
- https://discourse.joinmastodon.org
|
- Follow @fedibird_group@fedibird.com from Fediverse.
|
||||||
- #mastodon on irc.freenode.net
|
- #fedibird-users:matrix.fedibird.com on Matrix
|
||||||
|
|
|
||||||
4
.github/ISSUE_TEMPLATE/config.yml
vendored
4
.github/ISSUE_TEMPLATE/config.yml
vendored
|
|
@ -1,5 +1 @@
|
||||||
blank_issues_enabled: false
|
blank_issues_enabled: false
|
||||||
contact_links:
|
|
||||||
- name: Mastodon Meta Discussion Board
|
|
||||||
url: https://discourse.joinmastodon.org/
|
|
||||||
about: Please ask and answer questions here.
|
|
||||||
|
|
|
||||||
22
.github/dependabot.yml
vendored
22
.github/dependabot.yml
vendored
|
|
@ -1,22 +0,0 @@
|
||||||
# To get started with Dependabot version updates, you'll need to specify which
|
|
||||||
# package ecosystems to update and where the package manifests are located.
|
|
||||||
# Please see the documentation for all configuration options:
|
|
||||||
# https://help.github.com/github/administering-a-repository/configuration-options-for-dependency-updates
|
|
||||||
|
|
||||||
version: 2
|
|
||||||
updates:
|
|
||||||
- package-ecosystem: npm
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: weekly
|
|
||||||
open-pull-requests-limit: 99
|
|
||||||
allow:
|
|
||||||
- dependency-type: direct
|
|
||||||
|
|
||||||
- package-ecosystem: bundler
|
|
||||||
directory: "/"
|
|
||||||
schedule:
|
|
||||||
interval: weekly
|
|
||||||
open-pull-requests-limit: 99
|
|
||||||
allow:
|
|
||||||
- dependency-type: direct
|
|
||||||
10
.github/stale.yml
vendored
10
.github/stale.yml
vendored
|
|
@ -1,10 +0,0 @@
|
||||||
daysUntilStale: 120
|
|
||||||
daysUntilClose: 7
|
|
||||||
exemptLabels:
|
|
||||||
- security
|
|
||||||
staleLabel: wontfix
|
|
||||||
markComment: >
|
|
||||||
This issue has been automatically marked as stale because it has not had
|
|
||||||
recent activity. It will be closed if no further activity occurs. Thank you
|
|
||||||
for your contributions.
|
|
||||||
only: pulls
|
|
||||||
77
README.md
77
README.md
|
|
@ -1,61 +1,47 @@
|
||||||
|
Fedibird
|
||||||
========
|
========
|
||||||
|
|
||||||
[][releases]
|
[][releases]
|
||||||
[][circleci]
|
[][circleci]
|
||||||
[][code_climate]
|
[][code_climate]
|
||||||
[][crowdin]
|
|
||||||
[][docker]
|
|
||||||
|
|
||||||
[releases]: https://github.com/mastodon/mastodon/releases
|
[releases]: https://github.com/fedibird/mastodon/releases
|
||||||
[circleci]: https://circleci.com/gh/mastodon/mastodon
|
[circleci]: https://circleci.com/gh/fedibird/mastodon
|
||||||
[code_climate]: https://codeclimate.com/github/mastodon/mastodon
|
[code_climate]: https://codeclimate.com/github/fedibird/mastodon
|
||||||
[crowdin]: https://crowdin.com/project/mastodon
|
|
||||||
[docker]: https://hub.docker.com/r/tootsuite/mastodon/
|
|
||||||
|
|
||||||
Mastodon is a **free, open-source social network server** based on ActivityPub where users can follow friends and discover new ones. On Mastodon, users can publish anything they want: links, pictures, text, video. All Mastodon servers are interoperable as a federated network (users on one server can seamlessly communicate with users from another one, including non-Mastodon software that implements ActivityPub)!
|
Fedibird is a **free, open-source social network server** based on ActivityPub, which is a fork of Mastodon arranged with features maintained by Takeshi Umeda (noellabo). For the official version of Mastodon, please visit the [official website](https://joinmastodon.org) and the [upstream repository](https://github.com/mastodon/mastodon).
|
||||||
|
|
||||||
Click below to **learn more** in a video:
|
This document describes the differences from Mastodon. Please also refer to the upstream [README.md](https://github.com/mastodon/mastodon/blob/main/README.md).
|
||||||
|
|
||||||
[][youtube_demo]
|
## Mission
|
||||||
|
|
||||||
[youtube_demo]: https://www.youtube.com/watch?v=IPSbNdBmWKE
|
Fedibird's mission is to expand the possibilities of Mastodon and the Fediverse by providing features that the official Mastodon is unable to adopt for various reasons.
|
||||||
|
|
||||||
## Navigation
|
Some features are intentionally left out of the official Mastodon. Some features also bring a different user experience. Some features are simply in an experimental status.
|
||||||
|
|
||||||
- [Project homepage 🐘](https://joinmastodon.org)
|
Fedibird will follow the official Mastodon and provide feedback on the results obtained here.
|
||||||
- [Support the development via Patreon][patreon]
|
|
||||||
- [View sponsors](https://joinmastodon.org/sponsors)
|
|
||||||
- [Blog](https://blog.joinmastodon.org)
|
|
||||||
- [Documentation](https://docs.joinmastodon.org)
|
|
||||||
- [Browse Mastodon servers](https://joinmastodon.org/#getting-started)
|
|
||||||
- [Browse Mastodon apps](https://joinmastodon.org/apps)
|
|
||||||
|
|
||||||
[patreon]: https://www.patreon.com/mastodon
|
## Highlighted features
|
||||||
|
|
||||||
## Features
|
### Subscription
|
||||||
|
|
||||||
<img src="https://docs.joinmastodon.org/elephant.svg" align="right" width="30%" />
|
Feeds information of interest to your timeline in a different way than following. Accounts, hashtags, keywords, domains, and more.
|
||||||
|
|
||||||
**No vendor lock-in: Fully interoperable with any conforming platform**
|
### Emoji Reactions
|
||||||
|
|
||||||
It doesn't have to be Mastodon, whatever implements ActivityPub is part of the social network! [Learn more](https://blog.joinmastodon.org/2018/06/why-activitypub-is-the-future/)
|
Emoji reactions are available, compatible with Misskey and Pleroma.
|
||||||
|
|
||||||
**Real-time, chronological timeline updates**
|
### Quotes
|
||||||
|
|
||||||
See the updates of people you're following appear in real-time in the UI via WebSockets. There's a firehose view as well!
|
Allows quotes that are reachable to the original post, not dead copies.
|
||||||
|
|
||||||
**Media attachments like images and short videos**
|
### Groups
|
||||||
|
|
||||||
Upload and view images and WebM/MP4 videos attached to the updates. Videos with no audio track are treated like GIFs; normal videos are looped - like vines!
|
Allows you to create and manage groups, discover groups, a timeline dedicated to groups, and post to groups. You can join a group from your existing Fediverse account.
|
||||||
|
|
||||||
**Safety and moderation tools**
|
### Posts expiry
|
||||||
|
|
||||||
Private posts, locked accounts, phrase filtering, muting, blocking and all sorts of other features, along with a reporting and moderation system. [Learn more](https://blog.joinmastodon.org/2018/07/cage-the-mastodon/)
|
Posts can be made private when they expire. People who have favorited, bookmarked, or emoji-reacted to your posts will still be able to see them.
|
||||||
|
|
||||||
**OAuth2 and a straightforward REST API**
|
|
||||||
|
|
||||||
Mastodon acts as an OAuth2 provider so 3rd party apps can use the REST and Streaming APIs, resulting in a rich app ecosystem with a lot of choices!
|
|
||||||
|
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
|
|
@ -67,26 +53,21 @@ Mastodon acts as an OAuth2 provider so 3rd party apps can use the REST and Strea
|
||||||
|
|
||||||
**Requirements:**
|
**Requirements:**
|
||||||
|
|
||||||
- **PostgreSQL** 9.5+
|
- **PostgreSQL** 10+ (Note: Requires a newer version than Mastodon)
|
||||||
- **Redis** 4+
|
- **Redis** 4+
|
||||||
- **Ruby** 2.5+
|
- **Ruby** 2.5+
|
||||||
- **Node.js** 12+
|
- **Node.js** 12+
|
||||||
|
|
||||||
The repository includes deployment configurations for **Docker and docker-compose**, but also a few specific platforms like **Heroku**, **Scalingo**, and **Nanobox**. The [**stand-alone** installation guide](https://docs.joinmastodon.org/admin/install/) is available in the documentation.
|
|
||||||
|
|
||||||
A **Vagrant** configuration is included for development purposes.
|
|
||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Mastodon is **free, open-source software** licensed under **AGPLv3**.
|
Fedibird is **free, open-source software** licensed under **AGPLv3**.
|
||||||
|
|
||||||
You can open issues for bugs you've found or features you think are missing. You can also submit pull requests to this repository, or submit translations using Crowdin. To get started, take a look at [CONTRIBUTING.md](CONTRIBUTING.md). If your contributions are accepted into Mastodon, you can request to be paid through [our OpenCollective](https://opencollective.com/mastodon).
|
However, if you are not targeting Fedibird-specific features, please consider contributing to the upstream first; see Mastodon's [CONTRIBUTING.md](CONTRIBUTING.md). If you want to make an issue or pull request to Fedibird, please do so to the default branch of fedibird/mastodon.
|
||||||
|
|
||||||
**IRC channel**: #mastodon on irc.libera.chat
|
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
Copyright (C) 2016-2021 Eugen Rochko & other Mastodon contributors (see [AUTHORS.md](AUTHORS.md))
|
Copyright (C) 2018-2021 Takeshi Umeda
|
||||||
|
based on code by Mastodon Copyright (C) 2016-2021 Eugen Rochko & other Mastodon contributors (see [AUTHORS.md](AUTHORS.md))
|
||||||
|
|
||||||
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 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.
|
||||||
|
|
||||||
|
|
|
||||||
10
SECURITY.md
10
SECURITY.md
|
|
@ -2,12 +2,10 @@
|
||||||
|
|
||||||
## Supported Versions
|
## Supported Versions
|
||||||
|
|
||||||
| Version | Supported |
|
| Version | Supported |
|
||||||
| ------- | ------------------ |
|
| -------------- | ------------------ |
|
||||||
| 3.4.x | :white_check_mark: |
|
| v0.1 + 3.4.1 | :white_check_mark: |
|
||||||
| 3.3.x | :white_check_mark: |
|
|
||||||
| < 3.3 | :x: |
|
|
||||||
|
|
||||||
## Reporting a Vulnerability
|
## Reporting a Vulnerability
|
||||||
|
|
||||||
hello@joinmastodon.org
|
noellabo@fedibird.com
|
||||||
|
|
|
||||||
|
|
@ -33,7 +33,7 @@ module Mastodon
|
||||||
end
|
end
|
||||||
|
|
||||||
def repository
|
def repository
|
||||||
ENV.fetch('GITHUB_REPOSITORY', 'mastodon/mastodon')
|
ENV.fetch('GITHUB_REPOSITORY', 'fedibird/mastodon')
|
||||||
end
|
end
|
||||||
|
|
||||||
def source_base_url
|
def source_base_url
|
||||||
|
|
@ -53,8 +53,12 @@ module Mastodon
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
||||||
|
def fedibird_verson
|
||||||
|
'0.1'
|
||||||
|
end
|
||||||
|
|
||||||
def user_agent
|
def user_agent
|
||||||
@user_agent ||= "#{HTTP::Request::USER_AGENT} (Mastodon/#{Version}; +http#{Rails.configuration.x.use_https ? 's' : ''}://#{Rails.configuration.x.web_domain}/)"
|
@user_agent ||= "#{HTTP::Request::USER_AGENT} (Mastodon/#{Version} Fedibird/#{fedibird_verson}; +http#{Rails.configuration.x.use_https ? 's' : ''}://#{Rails.configuration.x.web_domain}/)"
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
end
|
end
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue