git.squeep.com Git - akkoma/blob - docs/docs/index.md

   1 **Note:** Akkoma documentation is still being updated, so you may still see references to Pleroma in many places.
   2
   3 # Introduction to Akkoma
   4 ## What is Akkoma?
   5 Akkoma is a federated social networking platform, compatible with Mastodon and other ActivityPub implementations. It is free software licensed under the AGPLv3.
   6 It actually consists of two components: a backend, named simply Akkoma, and a user-facing frontend, named Pleroma-FE. It also includes the Mastodon frontend, if that's your thing.
   7 It's part of what we call the fediverse, a federated network of instances which speak common protocols and can communicate with each other.
   8 One account on an instance is enough to talk to the entire fediverse!
   9
  10 ## Community Channels
  11
  12 ### IRC
  13
  14 For support or general questions, pop over to #akkoma and #akkoma-dev at [irc.akkoma.dev](https://irc.akkoma.dev) (port 6697, SSL)
  15
  16 ### Discourse
  17
  18 For more general meta-discussion, for example discussion of potential future features, head on over to [meta.akkoma.dev](https://meta.akkoma.dev)
  19
  20 ### Dev diaries and release notifications
  21
  22 will be posted via [@akkoma@ihba](https://ihatebeinga.live/users/akkoma)
  23
  24 ## How can I use it?
  25
  26 Akkoma instances are already widely deployed, a list can be found at <https://the-federation.info/pleroma> and <https://fediverse.network/pleroma>.
  27
  28 If you don't feel like joining an existing instance, but instead prefer to deploy your own instance, that's easy too!
  29 Installation instructions can be found in the installation section of these docs.
  30
  31 ## I got an account, now what?
  32 Great! Now you can explore the fediverse! Open the login page for your Akkoma instance (e.g. <https://pleroma.soykaf.com>) and login with your username and password. (If you don't have an account yet, click on Register)
  33
  34 ### Pleroma-FE
  35 The default front-end used by Akkoma is Pleroma-FE. You can find more information on what it is and how to use it in the [Introduction to Pleroma-FE](https://docs-fe.akkoma.dev/stable/).
  36
  37 ### Mastodon interface
  38 If the Pleroma-FE interface isn't your thing, or you're just trying something new but you want to keep using the familiar Mastodon interface, we got that too!
  39 Just add a "/web" after your instance url (e.g. <https://pleroma.soykaf.com/web>) and you'll end on the Mastodon web interface, but with a Akkoma backend! MAGIC!
  40 The Mastodon interface is from the Glitch-soc fork. For more information on the Mastodon interface you can check the [Mastodon](https://docs.joinmastodon.org/) and [Glitch-soc](https://glitch-soc.github.io/docs/) documentation.
  41
  42 Remember, what you see is only the frontend part of Mastodon, the backend is still Akkoma.
  43