From refs/heads/main 77b1ba6

.buildinfo

@@ -0,0 +1,4 @@
+# Sphinx build info version 1
+# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
+config: 350ef2bca2dcfc74b93be70953b820e5
+tags: 645f666f9bcd5a90fca523b33c5a78b7

README.md

@@ -0,0 +1,3 @@
+#GitHub Pages
+
+Last update of sphinx html documentation from [77b1ba6](https://github.com/PufferBlow/pufferblow/tree/77b1ba630b0b29c82343cb4d0a1096c804af80b2)

_sources/get_started.rst

@@ -0,0 +1,99 @@
+
+===============
+Get started
+===============
+
+To get started on hosting your own `pufferblow <https://github.com/PufferBlow/pufferblow>`__ server, you will need the following:
+
+* Linux VPS
+* PostgreSQL
+
+Setup a Linux VPS
+=================
+
+Numerous affordable VPS services are available, offering reliable Linux VPS solutions. Among the options that we recommend are:
+
+* `Oracle's Free tier <https://www.oracle.com/cloud/free>`_
+* `Contabo <https://contabo.com/en/>`_
+
+Setup PostgreSQL
+================
+
+Head over `PostgreSQL's download page <https://www.postgresql.org/download/>`_ and follow the instructions based on your distro.
+
+Install pufferblow
+=====================
+
+Installing **pufferblow** is very straight forward all you need to do is:
+
+* Install via Git:
+
+.. code-block:: bash
+
+    pip install git+https://github.com/pufferblow/pufferblow.git
+
+* Build from source:
+
+.. code-block:: bash
+
+    git clone https://github.com/pufferblow/pufferblow.git --depth=1
+    cd pufferblow
+    pip install -e .
+
+Setup pufferblow
+================
+
+pufferblow has a command called setup that enables you to set it up, all you need to do is run the following:
+
+.. code-block:: bash
+
+    pufferblow setup
+
+if it detects that a config file is already present, the following will be outputed:
+
+.. code-block::
+
+    A config file already exists. Do you want to continue? [y/n]:
+
+but normaly it will ask you for your postgreSQL database name, the default is postgres:
+
+.. code-block::
+
+    PostgreSQL database name (postgres):
+
+then it will ask you about the database's username, password, host and port:
+
+.. code-block::
+
+    PostgreSQL database username:
+    PostgreSQL database password:
+    PostgreSQL database host:
+    PostgreSQL database name port:
+
+after that it will ask you about some light info on your server, like the server name, description, welcome message:
+
+.. code-block::
+
+    Enter your server's name:
+    Enter your server's description:
+    Enter your server's welcome message for new members:
+
+and lastly the username, password for the admin user:
+
+.. code-block::
+
+    Enter your owner account username:
+    Enter your owner account password:
+
+.. note::
+
+    Don't panic when typing in a password; it will not be shown by design.
+
+Start your pufferblow server
+============================
+
+Now you can start your pufferblow server with the following command:
+
+.. code-block:: bash
+
+    pufferblow serve

_sources/index.rst

@@ -0,0 +1,10 @@
+
+Welcome to **pufferblow**'s documentation!
+===============================================
+
+.. toctree::
+    :maxdepth: 2
+    :caption: Contents:
+
+    introduction
+    get_started

_sources/introduction.rst

@@ -0,0 +1,18 @@
+==============================
+Introduction to pufferblow
+==============================
+
+Introduction
+============
+
+The **pufferblow** is the official open-source server for **pufferblow**. Using it you can host your own server and create a community for you, your friends, and potentially others to join and spend wonderful times together. One of the key strengths of the **pufferblow** is its robust security measures. Being open-source and free to use, it ensures your privacy as it implements advanced encryption algorithms such as Blowfish and bcrypt for data hashing and encryption, making the **pufferblow** a secure choice for hosting your own server.
+Unlike many other chat services that offer little control to the server owner, such as Discord and Guilded, **pufferblow** stands apart. With **pufferblow**, you have the ability to host your own server using **pufferblow** and customize it according to your preferences.
+
+The ideology of pufferblow
+==============================
+
+This software enables users to host their own servers or instances while maintaining a consistent user experience across all these servers. Furthermore, users only need to create a single account on one server, which will be synchronized across all instances (aka fediverse network).
+
+.. note::
+
+   As of version **v0.0.1-beta**, **pufferblow** does not yet support the Fediverse. However, this feature is planned for future releases. The primary reason for creating **pufferblow** was to develop a Fediverse-compatible Discord-like chat service, which aligns with the ethos of the Fediverse itself.

_sources/modules.rst

@@ -0,0 +1,6 @@
+pufferblow
+==========
+
+.. toctree::
+   :maxdepth: 4
+