Code Monkey home page Code Monkey logo

dolphin's Introduction

Dolphin

Dolphin

Dolphin is a lightweight ActivityPub server for personal (or team).

Become a Patron!

๐Ÿ€ Why Dolphin

Dolphin is a fork of Misskey and a sister project of it. While inheriting attractive 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

Create Dolphin user

Running dolphin as root is not a good idea so we need to create another user for that

For example:

adduser --disabled-password --disabled-login dolphin

Install dependencies

Please install and setup these softwares:

Install Dolphin

  1. Connect to Dolphin user

    su - dolphin

  2. Clone the Dolphin repo

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

  3. Navigate to Dolphin directory

    cd dolphin

  4. 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

dolphin's People

Contributors

mei23 avatar okpierre avatar syuilo avatar

Stargazers

 avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.