Skip to content
🐬 A Lightweight ActivityPub Server
TypeScript Vue Other
Branch: develop
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.config
.github
assets
locales
migration
src
.dockerignore
.editorconfig
.eslintrc
.gitattributes
.gitignore
.node-version
.npmrc
CHANGELOG.md
CODE_OF_CONDUCT.md
Dockerfile
LICENSE
Procfile
README.md
crowdin.yml
docker-compose.yml
gulpfile.ts
index.js
ormconfig.js
package.json
tsconfig.json
tslint.json
webpack.config.ts

README.md

Dolphin

Dolphin

Dolphin is a lightweight ActivityPub server optimized for single user (or few users) use.

Become a Patron!

πŸ€ Why Dolphin

Dolphin is a fork of Misskey and a sister project of it. While inheriting features such as reaction and high performance, it has been optimized for single-user use. As a result, it is easier to use and lighter.

Looking for a lightweight, high-performance ActivityPub server? Want to use Misskey, but is it heavy to use alone? Try Dolphin.

✨ Gallery

πŸ“Š Comparison

Misskey Dolphin Mastodon
Reactions βœ”οΈ βœ”οΈ ❌
LTL βœ”οΈ ❌ βœ”οΈ
STL βœ”οΈ ❌ ❌
GTL βœ”οΈ ❌ βœ”οΈ
Messaging βœ”οΈ ❌ ❌
Games βœ”οΈ ❌ ❌
Pages βœ”οΈ ❌ ❌
List βœ”οΈ βœ”οΈ βœ”οΈ
Group βœ”οΈ ❌ ❌

Build time

X axis represents seconds. Lower is better.

πŸ“¦ Install

Install dependencies

Please install and setup these softwares:

Install Dolphin

  1. Clone the Dolphin repo

    git clone -b master git://github.com/syuilo/dolphin.git

  2. Navigate to Dolphin directory

    cd dolphin

  3. Install Dolphin dependencies.

    npm i

Configure Dolphin

  1. Copy the .config/example.yml and rename it to default.yml.

    cp .config/example.yml .config/default.yml

  2. Edit default.yml

    e.g. vim .config/default.yml

Build Dolphin

Build dolphin with the following:

NODE_ENV=production npm run build

If you're on Debian... You will need to install the `build-essential`, `python` package.
If you're still encountering errors about some modules... Use node-gyp:
  1. npx node-gyp configure
  2. npx node-gyp build
  3. NODE_ENV=production npm run build

Initialize database

npm run init

That is it.

Launch Dolphin

NODE_ENV=production npm start

Enjoy!

πŸ†• How to update your Dolphin

  1. git pull
  2. npm i
  3. NODE_ENV=production npm run build
  4. npm run migrate
  5. Restart your Dolphin process to apply changes

πŸ› οΈ Contribution

Localization

Visit https://crowdin.com/project/dolphin-ap

You can’t perform that action at this time.