bida/bastodon
6
0
Fork 0
Code Issues 7 Pull requests Releases Wiki Activity
bastodon/README.md
jops 5d6d618807 bastodon: README
2024-08-31 03:33:01 +02:00

2.3 KiB
Raw Permalink Blame History

Bastodon

Bastodon is a fork of the popular open-source social networking server, Mastodon. It retains the core features of Mastodon while introducing unique enhancements tailored to improve user experience and customization. Developed and maintained by the Bida Collective (bida.im), Bastodon brings additional flexibility to your social networking platform.

Key Features

  • Variable Character Limit: Customize the maximum number of characters per post to fit your needs.
  • Neighborhood Timeline: A new timeline feature that lets you view posts from selected instances, offering a focused feed of content from your chosen communities.

Installation

To set up Bastodon, follow the instructions below:

  1. Clone the Repository

    git clone https://git.lattuga.net/bida/bastodon.git
cd bastodon

  2. Install Dependencies

    Follow the installation instructions for dependencies as outlined in the Mastodon documentation, then apply the additional configurations specific to Bastodon.

  3. Configure Environment Variables

    Add the following environment variables to your .env file to enable and configure the new features:

    NEIGHBORHOOD_TIMELINE_ENABLED=true
NEIGHBORHOOD_INSTANCES=localhost,nil
MAX_CHARS=840
    • NEIGHBORHOOD_TIMELINE_ENABLED: Set to true to activate the Neighborhood Timeline.
    • NEIGHBORHOOD_INSTANCES: Comma-separated list of instances to include in the Neighborhood Timeline.
    • MAX_CHARS: Maximum number of characters allowed per post.

    These are example values; adjust them according to your specific needs.

Configuration

For detailed configuration and customization, refer to the updated documentation provided within the Bastodon repository. The core functionality mirrors Mastodon, but with additional parameters for character limits and timeline settings.

Development

Bastodon is an open-source project. If you have contributions or improvements, please follow the contributing guidelines outlined in the repository. The Bida Collective actively manages and maintains the codebase.

Support

For support or inquiries, contact the Bida Collective at bida.im or open an issue on the repository.

License

Bastodon is licensed under the GNU Affero General Public License v3.0 (AGPL-3.0). See the LICENSE file for details.