ditto/README.md

70 lines
2.2 KiB
Markdown
Raw Normal View History

2023-04-02 19:10:50 +00:00
# Ditto
2023-07-12 18:53:58 +00:00
Ditto is a tiny but powerful social media server for the decentralized web. With Ditto you will be able to interact across protocols and networks, and build your own social media experience.
<img width="400" src="ditto-planet.png">
2023-07-12 18:53:58 +00:00
2023-07-12 04:24:41 +00:00
⚠️ This software is a work in progress.
2023-07-12 18:53:58 +00:00
## Supported protocols
- [x] Nostr
- [ ] ActivityPub
## Features
- [ ] Follow users across networks
- [ ] Post to multiple networks at once
- [x] Log in with any Mastodon app
- [x] Like and comment on posts
- [x] Share posts
- [ ] Reposts
- [ ] Notifications
- [x] Profiles
- [ ] Search
- [ ] Moderation
- [x] Customizable
- [x] Open source
- [x] Self-hosted
- [x] Decentralized
- [x] No ads
- [x] No tracking
- [x] No censorship
## Federation
Ditto is primarily a Nostr client, using a Nostr relay as its database. ActivityPub objects are translated into Nostr events in realtime and cached by the Ditto server. When you submit a post, it sends it to your Nostr relay and then fans it out to the ActivityPub network.
The main way to use Ditto is with a Mastodon app. Or you can connect directly to the Nostr relay with a Nostr client.
## Installation
TODO
## Development
1. Install [Deno](https://deno.land).
2024-03-29 17:59:11 +00:00
2. Clone this repo.
3. Download [Soapbox](https://dl.soapbox.pub/) or another web-based Mastodon client of your choice.
4. Put the frontend files inside the `public` directory.
2024-03-29 20:26:10 +00:00
5. Create an `.env` file.
6. Define `DITTO_NSEC=<value>` in your .env file. You can generate an nsec by running `deno task nsec`.
2024-03-29 20:26:10 +00:00
7. Run `deno task dev`.
2023-07-12 18:53:58 +00:00
## License
© Alex Gleason & other Ditto contributors
Ditto 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.
Ditto 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 Ditto. If not, see <https://www.gnu.org/licenses/>.