diff --git a/.github/workflows/deploy.yml b/.github/workflows/deploy.yml index bbfbad9..d8ab6c0 100644 --- a/.github/workflows/deploy.yml +++ b/.github/workflows/deploy.yml @@ -34,13 +34,33 @@ jobs: path: assets/ retention-days: 1 + build_vue: + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@v3 + with: + fetch-depth: 0 + - uses: actions/setup-node@v3 + with: + node-version: 20 + - name: Build + run: | + cd ./vuepress-starter/ + npm i + npm run docs:build + - name: Save Artifact Build + uses: actions/upload-artifact@v3 + with: + name: dist + path: ./vuepress-starter/docs/.vuepress/dist/ + retention-days: 1 + deploy_win: runs-on: docs-en-deploy needs: build steps: - name: Download artifacts uses: actions/download-artifact@v3 - - name: Copy artifacts run: | cp -Recurse -Force ./build/site/* c:/inetpub/wwwroot/docs/en/ @@ -52,8 +72,18 @@ jobs: steps: - name: Download artifacts uses: actions/download-artifact@v3 - - name: Copy artifacts run: | cp -r ./build/site/* /data/docs/en/ cp -r ./assets/* /data/docs/ + + deploy_docs_pocketnet_app: + runs-on: docs.bastyon.com + needs: build_vue + steps: + - name: Download artifacts + uses: actions/download-artifact@v3 + - name: Copy artifacts + run: | + rm -rf /data/documentation/* + cp -r ./dist/* /data/documentation/ \ No newline at end of file diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..e04a1e9 --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,8 @@ +{ + "grammarly.selectors": [ + { + "language": "markdown", + "scheme": "file" + } + ] +} \ No newline at end of file diff --git a/documentation-approach-en.md b/documentation-approach-en.md index eec3f49..f76b50b 100644 --- a/documentation-approach-en.md +++ b/documentation-approach-en.md @@ -1,9 +1,5 @@ The plan for Developer's Guide -AI Prompts: -I am trying to design a documentation strategy for Bastyon. I am a volunteer there who wants to help the project to move forward. -The project is called Bastyon. It's a decentralized social platform with a messenger. It also wants to build an API set around building miniapps on Bastyon. Its source code is located at https://github.com/pocketnetteam -The documentation is needed for app usage and developer documentation. -What I need help with a vision for documentation, roadmap and concrete documentation design that adheres with the theory of information and other theoretical work around documentation design. + ### Motivation diff --git a/vuepress-starter/.github/workflows/deploy-docs.yml b/vuepress-starter/.github/workflows/deploy-docs.yml new file mode 100644 index 0000000..cb217ba --- /dev/null +++ b/vuepress-starter/.github/workflows/deploy-docs.yml @@ -0,0 +1,47 @@ + +name: Deploy Docs + +on: + push: + branches: + # make sure this is the branch you are using + - main + +permissions: + contents: write + +jobs: + deploy-gh-pages: + runs-on: ubuntu-latest + steps: + - name: Checkout + uses: actions/checkout@v3 + with: + fetch-depth: 0 + # if your docs needs submodules, uncomment the following line + # submodules: true + + + + - name: Setup Node.js + uses: actions/setup-node@v3 + with: + node-version: 20 + cache: npm + + - name: Install Deps + run: npm ci + + - name: Build Docs + env: + NODE_OPTIONS: --max_old_space_size=8192 + run: |- + npm run docs:build + > docs/.vuepress/dist/.nojekyll + + - name: Deploy Docs + uses: JamesIves/github-pages-deploy-action@v4 + with: + # This is the branch where the docs are deployed to + branch: gh-pages + folder: docs/.vuepress/dist diff --git a/vuepress-starter/.gitignore b/vuepress-starter/.gitignore new file mode 100644 index 0000000..fe17425 --- /dev/null +++ b/vuepress-starter/.gitignore @@ -0,0 +1 @@ +**/dist \ No newline at end of file diff --git a/vuepress-starter/docs/.vuepress/.gitignore b/vuepress-starter/docs/.vuepress/.gitignore new file mode 100644 index 0000000..e23b120 --- /dev/null +++ b/vuepress-starter/docs/.vuepress/.gitignore @@ -0,0 +1,3 @@ +.cache +.temp +dist \ No newline at end of file diff --git a/vuepress-starter/docs/.vuepress/config.js b/vuepress-starter/docs/.vuepress/config.js new file mode 100644 index 0000000..0d3fa60 --- /dev/null +++ b/vuepress-starter/docs/.vuepress/config.js @@ -0,0 +1,28 @@ +import { defaultTheme } from '@vuepress/theme-default' +import { defineUserConfig } from 'vuepress/cli' +import { viteBundler } from '@vuepress/bundler-vite' + +export default defineUserConfig({ + lang: 'en-US', + title: ' ', + description: 'This documentation will help you get started with Bastyon.', + + theme: defaultTheme({ + logo: '/bastyon-logo-32x32.png', + + navbar: ['/', '/get-started'], + }), + plugins: [ + [ + 'vuepress-plugin-mathjax', + { + target: 'svg', + macros: { + '*': '\\times', + }, + }, + ], + ], + + bundler: viteBundler(), +}) \ No newline at end of file diff --git a/vuepress-starter/docs/.vuepress/public/bastyon-logo-256x256.png b/vuepress-starter/docs/.vuepress/public/bastyon-logo-256x256.png new file mode 100644 index 0000000..567bbec Binary files /dev/null and b/vuepress-starter/docs/.vuepress/public/bastyon-logo-256x256.png differ diff --git a/vuepress-starter/docs/.vuepress/public/bastyon-logo-32x32.png b/vuepress-starter/docs/.vuepress/public/bastyon-logo-32x32.png new file mode 100644 index 0000000..5eabc04 Binary files /dev/null and b/vuepress-starter/docs/.vuepress/public/bastyon-logo-32x32.png differ diff --git a/vuepress-starter/docs/README.md b/vuepress-starter/docs/README.md new file mode 100644 index 0000000..4ee6521 --- /dev/null +++ b/vuepress-starter/docs/README.md @@ -0,0 +1,30 @@ +--- +home: true +title: Home +heroImage: /bastyon-logo-256x256.png +actions: + - text: Developer Documentation + link: /en/dev-docs/get-started-dev.md + type: primary + + - text: Monetize With Bastyon + link: /en/user-docs/get-started-user.md + type: primary + +features: + - title: Freedom of Expression + details: The platform operates without a central authority, making it resistant to traditional censorship methods. + - title: Diverse Content Sharing + details: Users can post a variety of content including text, videos, and long-form blogs with minimal restrictions. + - title: Earn Cryptocurrency + details: Users can monetize their content and interactions using PKOIN, Bastyon's native cryptocurrency. + - title: Enhanced Privacy + details: Users can interact on the platform without concerns about their personal data being collected or sold. + - title: Trusted Content Storage + details: Users benefit from decentralized technology ensuring their content remains unaltered and accessible. + - title: Flexible Access + details: Bastyon is available on iOS, Android, as a desktop app, and as a web app via web most web browsers. + + +footer: Apache License-2.0 | Copyright © 2019-present Bastyon +--- diff --git a/vuepress-starter/docs/en/user-docs/Digifinex.png b/vuepress-starter/docs/en/user-docs/Digifinex.png new file mode 100644 index 0000000..4ce689d Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/Digifinex.png differ diff --git a/vuepress-starter/docs/en/user-docs/advertisement-cpm-calculation.md b/vuepress-starter/docs/en/user-docs/advertisement-cpm-calculation.md new file mode 100644 index 0000000..5440dd6 --- /dev/null +++ b/vuepress-starter/docs/en/user-docs/advertisement-cpm-calculation.md @@ -0,0 +1,54 @@ +# CPM Derivation + + +Bastyon has about 1.63 MILLION unique visitors a month. Average visitor visits 5 times per month, and English language feed is 10% of Bastyon, so TOTAL NUMBER OF MONTHLY VISITS = 1.65M * 10% * 5 = 815,000.1 + +1.63M visits are distributed across various platforms: + +| Platform 2 | Users | +|------------------|---------| +| Bastyon.com | 1.4M | +| Android | 130k | +| Desktop app | 100k | + + +### Bastyon.com Usage + +1.4M is on Bastyon.com (SEMRUSH data) + +![alt text](semrush-bastyon-data.png) + +### Desktop App Usage + +Number of desktop app users is 150,000+.3 + +[![alt text](bastyon-desktop-browser.png)](https://github.com/pocketnetteam/pocketnet.gui) + +### Android Usage + +Number of active android users is 130,000+ + + +### iOS Usage + + + + +### CPM Calculation + +1. Every boost ad runs for 3 hours. So, we divide total monthly visits by 30 days and by 8 to get 3-hour intervals +2. Total monthly visits = 815 thousand +3. Total daily visits = 27,100 +4. English feed has 10% of all visitors +5. Total visits in 3 hour interval = 27,100/8 = 3395 +6. Average cost of ad is $1 +7. CPM = $. 29 +8. 29 cents on average is a very low CPM + +*** + +1Based on December 2022 data. + +2 iOS was not initially included in the calculations + +3 After every app update users gradually update desktop app, approx. Half of users updates one week after update. The image shows that 76 thousand users updated their apps immediately on day one, only half of the people update so quickly, so the real number is 150k users approximately \ No newline at end of file diff --git a/vuepress-starter/docs/en/user-docs/bastyon-desktop-browser.png b/vuepress-starter/docs/en/user-docs/bastyon-desktop-browser.png new file mode 100644 index 0000000..87b7ec3 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/bastyon-desktop-browser.png differ diff --git a/vuepress-starter/docs/en/user-docs/bastyon-homepage-header.png b/vuepress-starter/docs/en/user-docs/bastyon-homepage-header.png new file mode 100644 index 0000000..1b3736a Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/bastyon-homepage-header.png differ diff --git a/vuepress-starter/docs/en/user-docs/bastyon-usage-audience.png b/vuepress-starter/docs/en/user-docs/bastyon-usage-audience.png new file mode 100644 index 0000000..fa66c05 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/bastyon-usage-audience.png differ diff --git a/vuepress-starter/docs/en/user-docs/bastyon-usage-distribution-by-country.png b/vuepress-starter/docs/en/user-docs/bastyon-usage-distribution-by-country.png new file mode 100644 index 0000000..7cb0b6d Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/bastyon-usage-distribution-by-country.png differ diff --git a/vuepress-starter/docs/en/user-docs/bastyon-usage-employment-status.png b/vuepress-starter/docs/en/user-docs/bastyon-usage-employment-status.png new file mode 100644 index 0000000..e4d7baf Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/bastyon-usage-employment-status.png differ diff --git a/vuepress-starter/docs/en/user-docs/buying-pkoin-from-private-party.png b/vuepress-starter/docs/en/user-docs/buying-pkoin-from-private-party.png new file mode 100644 index 0000000..f8e1327 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/buying-pkoin-from-private-party.png differ diff --git a/vuepress-starter/docs/en/user-docs/buying-pkoin.md b/vuepress-starter/docs/en/user-docs/buying-pkoin.md new file mode 100644 index 0000000..f86ff2c --- /dev/null +++ b/vuepress-starter/docs/en/user-docs/buying-pkoin.md @@ -0,0 +1,34 @@ +# Buying PKOIN + +PKOIN is the native cryptocurrency of the Bastyon platform. It serves as the economic backbone of the ecosystem, enabling users to monetize their content and interactions. Users can earn PKOIN through various activities on the platform, such as creating popular posts, receiving likes, being the node-runners. + +PKOIN can be used for: +1. Tipping content creators +2. Boosting posts for increased visibility +3. Accessing premium features on the platform +4. Trading with other cryptocurrencies or fiat currencies + +To acquire PKOIN, users have several options: + +1. Private parties: Users can arrange peer-to-peer transactions with other PKOIN holders through secure messaging channels or community forums. + +2. Exchange services: Cryptocurrency exchange services may offer PKOIN trading pairs. + + +## Buying PKOIN on Exchanges and Exchange Services + +PKOIN can be purchased on the following sites. + +[![Alt text](tapbit.png)](Tapbit.com) + +[![alt text](Digifinex.png)](Digifinex.com) + + +[PKOIN.NET](https://pkoin.net) + + +## Buying PKOIN peer-to-peer on Bastyon + +You can also purchase PKOIN from other Bastyon users. You can agree on the terms of purchase/sale in personal correspondence with the seller / buyer, whom you can find in the news feed under the **PKOIN/peer-to-peer** category. + +![alt text](buying-pkoin-from-private-party.png) \ No newline at end of file diff --git a/vuepress-starter/docs/en/user-docs/db-indexing.png b/vuepress-starter/docs/en/user-docs/db-indexing.png new file mode 100644 index 0000000..55398f6 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/db-indexing.png differ diff --git a/vuepress-starter/docs/en/user-docs/easy-node-bastyon-data-sync-complete.png b/vuepress-starter/docs/en/user-docs/easy-node-bastyon-data-sync-complete.png new file mode 100644 index 0000000..2e6dba3 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/easy-node-bastyon-data-sync-complete.png differ diff --git a/vuepress-starter/docs/en/user-docs/easy-node-bastyon-data-sync.png b/vuepress-starter/docs/en/user-docs/easy-node-bastyon-data-sync.png new file mode 100644 index 0000000..51f120f Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/easy-node-bastyon-data-sync.png differ diff --git a/vuepress-starter/docs/en/user-docs/easy-node-bastyon-node.png b/vuepress-starter/docs/en/user-docs/easy-node-bastyon-node.png new file mode 100644 index 0000000..e974c34 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/easy-node-bastyon-node.png differ diff --git a/vuepress-starter/docs/en/user-docs/easy-node-installing.png b/vuepress-starter/docs/en/user-docs/easy-node-installing.png new file mode 100644 index 0000000..02cc11d Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/easy-node-installing.png differ diff --git a/vuepress-starter/docs/en/user-docs/easy-node-management.png b/vuepress-starter/docs/en/user-docs/easy-node-management.png new file mode 100644 index 0000000..ce1a761 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/easy-node-management.png differ diff --git a/vuepress-starter/docs/en/user-docs/easy-node-ready-running.png b/vuepress-starter/docs/en/user-docs/easy-node-ready-running.png new file mode 100644 index 0000000..4e82ee0 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/easy-node-ready-running.png differ diff --git a/vuepress-starter/docs/en/user-docs/easy-node-setup.md b/vuepress-starter/docs/en/user-docs/easy-node-setup.md new file mode 100644 index 0000000..aaaa882 --- /dev/null +++ b/vuepress-starter/docs/en/user-docs/easy-node-setup.md @@ -0,0 +1,152 @@ +# Easy Node Setup Guide + +## Important Notice + +**Download and install Pocketnet Team software only from official sources!** + +Official page on GitHub: [https://github.com/pocketnetteam](https://github.com/pocketnetteam) + +## Download Links + +Bastyon / Brighteon client application for personal computers (with Easy Node installation capability): +- GitHub: [https://github.com/pocketnetteam/pocketnet.gui/releases](https://github.com/pocketnetteam/pocketnet.gui/releases) + +Download options: +- For Windows: BastyonSetup.exe +- For Linux: BastyonSetup.deb + +> **Important Notes:** +> - The node has its own wallet and is not connected to the account +> - **Do not deposit Pocketcoin into your node wallet until you have fully configured your node and backed up your node wallet!** + +## System Requirements + +# Bastyon Node System Requirements Guide + +## Overview + +This guide outlines the system requirements for a Bastyon node that will function as a public node to service the Bastyon front end, including wallet and coin staking capabilities. + +> **Important Note:** Node requirements are subject to change as the network grows. + + +## System Requirements + +### Minimum Requirements + +| Component | Specification | +|-----------|---------------| +| OS | Windows 7 or higher (64 bit) / Linux (Debian, Ubuntu, Mint, etc.) (64 bit) | +| Processor | 2 core x86-64 CPU | +| RAM | 4 GB | +| Internet | 10 Mbit | +| Storage | 150 GB* free SSD space for blockchain storage | + +### Recommended Requirements + +| Component | Specification | +|-----------|---------------| +| OS | Windows 7 or higher (64 bit) / Linux (Debian, Ubuntu, Mint, etc.) (64 bit) | +| Processor | 4 core x86-64 CPU | +| RAM | 12 GB | +| Internet | - 100 Mbit
- Publicly accessible IP address and ports (see Network Setup section) | +| Storage | Same as minimum requirements | + +## Additional Notes + +1. **Storage Growth:** + - Disk space consumption may increase over time due to blockchain growth. + +2. **Initial Synchronization:** + - Extra free space on the system disk and a large amount of RAM are required only during the first synchronization of the blockchain. + +3. **Low RAM Troubleshooting:** + - If you have less RAM than recommended and the program closes automatically when you first start the node, increase the size of the paging file or swap file. + +## Network Setup + +For optimal performance as a public node, ensure: +- Your node has a publicly accessible IP address +- Necessary ports are open and properly configured (refer to network configuration documentation for specific port requirements) + + +## Installation Process + +1. Install the Bastyon/Brighteon client (recommended in the default path). +2. Launch the client and create a new Bastyon account or log into an existing one. +3. To install and launch Easy Node, go to your account menu in the top right corner of the Bastyon / Brighteon home page. + +![Bastyon homepage header](bastyon-homepage-header.png) + +4. Go to the menu (Management) - (Node). + +![Easy Node management](easy-node-management.png) + +5. Specify the directory for blockchain files storage (must be on an SSD, path in English only). +6. Click "Default Directory" to set the path, then "Download and install node". +7. The download of the database checkpoint and its further unzipping will begin. + +![Easy Node installing](easy-node-installing.png) + +8. The process of checking the database and starting synchronization with the network will begin. + +![Easy Node Bastyon node](easy-node-bastyon-node.png) + +> **Pay attention to the height:** First number = blocks on your node / Second number = blocks on the network + +![Easy Node Bastyon data sync](easy-node-bastyon-data-sync.png) + +9. Wait for full network synchronization (indicated by matching blockchain heights). + +![Easy Node Bastyon data sync complete](easy-node-bastyon-data-sync-complete.png) + +## Using Easy Node + +After installation and synchronization, the Easy Node window will display: + +![Easy Node ready and running](easy-node-ready-running.png) + +### Synchronization +- Status: active (Node is running) +- Version: [installed node version] +- Chain: main +- Height: [current block in the network] +- Block hash: [hash sum of the current block] + +### Wallet +- Status: [Node status and staking status] +- Control options: + - Deposit (Add Pocketcoin to node's wallet) + - Transfer (Send Pocketcoin from node wallet) + - Export wallet (Archive copy of wallet's private key) + - Import wallet (Restore wallet using private key) + +### Configuration +- Enabled: Turn node on/off +- Data path: Working directory of the node +- Node update: Available update version + +> **Note:** After turning off the node, it becomes possible to delete the node and the working directory. **Attention!** Do not delete the node if you do not have an archived copy of the node's wallet. + +## Important Wallet Management + +**Before depositing Pocketcoin:** +1. Export the wallet's private key and save it securely. +2. Make a copy of the Wallet.dat file: + - Turn off the node (Enabled - no) + - Locate Wallet.dat in the node's working directory + - Copy to multiple safe storage locations + +> **Note:** Copy the wallet file only to a switched off node, otherwise it may be copied with an error. +> One backup of Wallet.dat and private key is sufficient (No need to make new backup copies after each transaction). + +### Depositing Pocketcoin +1. Click "Deposit" +2. Use the displayed public address + +> **Note:** A new public address is generated each time for privacy, but old addresses remain valid. + +### Transferring Pocketcoin +1. Click "Transfer" +2. Provide transfer address, amount, and commission payer +3. Click "Send" \ No newline at end of file diff --git a/vuepress-starter/docs/en/user-docs/full-node-setup.md b/vuepress-starter/docs/en/user-docs/full-node-setup.md new file mode 100644 index 0000000..87b6a6b --- /dev/null +++ b/vuepress-starter/docs/en/user-docs/full-node-setup.md @@ -0,0 +1,231 @@ +# Full Node Setup Guide + +This guide provides instructions on how to set up a node to support the PocketNet blockchain network and the Bastyon decentralized social media app. PocketNet Core node operators are rewarded with the platform cryptocurrency, PKOIN, by participating in a process called staking, which generates new blocks on the blockchain. For more details about the PocketNet network, please refer to our whitepaper. + +The Bastyon social media site can be accessed at [https://bastyon.com](https://bastyon.com) + + +## System Requirements + +### Minimum Requirements + +| Component | Specification | +|-----------|---------------| +| OS | Windows 7 or higher (64 bit) / Linux (Debian, Ubuntu, Mint, etc.) (64 bit) | +| Processor | 2 core x86-64 CPU | +| RAM | 4 GB | +| Internet | 10 Mbit | +| Storage | 150 GB* free SSD space for blockchain storage | + +### Recommended Requirements + +| Component | Specification | +|-----------|---------------| +| OS | Windows 7 or higher (64 bit) / Linux (Debian, Ubuntu, Mint, etc.) (64 bit) | +| Processor | 4 core x86-64 CPU | +| RAM | 12 GB | +| Internet | - 100 Mbit
- Publicly accessible IP address and ports (see Network Setup section) | +| Storage | Same as minimum requirements | + +## Additional Notes + +1. **Storage Growth:** + - Disk space consumption may increase over time due to blockchain growth. + +2. **Initial Synchronization:** + - Extra free space on the system disk and a large amount of RAM are required only during the first synchronization of the blockchain. + +3. **Low RAM Troubleshooting:** + - If you have less RAM than recommended and the program closes automatically when you first start the node, increase the size of the paging file or swap file. + +## Network Setup + +For optimal performance as a public node, ensure: +- Your node has a publicly accessible IP address +- Necessary ports are open and properly configured (refer to network configuration documentation for specific port requirements) + +## Linux Setup (Ubuntu, Debian, Mint, etc.) + +1. Download the latest `pocketnetcore_*_linux_x64_setup.deb` package from the project [releases page](https://github.com/pocketnetteam/pocketnet.core/releases). + +2. Install the package with root privileges. Open the terminal in the directory where you downloaded the installer and execute the command: + + ```bash + $ sudo dpkg -i pocketnetcore_*_linux_x64_setup.deb + ``` + +3. On Ubuntu and many Linux distributions, it's necessary to set the open files limit to 10000 to prevent errors. Run `ulimit -n` to view the current open file limit. Set the limit to 10000 open files with: + + ```bash + $ ulimit -n 10000 + ``` + +4. After installation, start the GUI pocketcoin client from the command line: + + ```bash + $ pocketcoin-qt + ``` + + (For running the PocketNet Core node from the command line or in headless mode, refer to the "Running a Headless Node from the Command Line" section later in this document.) + +At this point, the PocketNet Core client will start synchronizing with the network. Depending on network performance, full synchronization can take anywhere from a few days to over a week to complete. If you need to bring a node up in a short period, you can download a checkpoint by following the instructions in the [Starting a Node From a Blockchain Snapshot](#starting-node-from-a-blockchain-snapshot) section below. However, it's recommended to allow a node to synchronize with the network on its own, as this validates the public blockchain and provides additional security and decentralization. During this time, the node unpacks the associated SQL database. You can track the unpacking process by monitoring the increase in the size of the working directory. + +## Windows Setup + +1. Download the `pocketnetcore_*_win_x64_setup.exe` installer from the GitHub [releases page](https://github.com/pocketnetteam/pocketnet.core/releases). + +2. Run the installer and follow the instructions, changing the installation location if necessary. + +3. Start the PocketNet Core application from the Windows Start menu. A Windows Security Alert will pop up for Windows Defender Firewall. Select "Allow access" to allow PocketNet Core through the Windows Defender Firewall for Private networks. + + ![Windows Security Alert](windows-security-alert.png) + +4. You will be prompted with a Setup Wizard: + + ![Setup Wizard](setup-wizzard.png) + + > **Important!** After installing the node program and launching it for the first time, you need to specify the path to the node's working directory! + +5. Select "Use custom data directory" and specify the path to the node's working directory, then click OK. + + ![Welcome Path Setup](welcome-path-setup.png) + +6. The program will launch and begin indexing the database: + + ![Database Indexing](db-indexing.png) + +7. The PocketNet Core client will start synchronizing with the network. Depending on network performance, full synchronization can take anywhere from a few days to over a week to complete. For faster setup, you can download a checkpoint by following the instructions in the [Starting a Node From a Blockchain Snapshot](#starting-node-from-a-blockchain-snapshot) section below. However, it's recommended to allow a node to synchronize with the network on its own, as this validates the public blockchain and provides additional security and decentralization. + + ![PocketNet Network Synchronization](pocketnet-network-synchronization.png) + +8. After synchronization, the main node window will launch: + + ![PocketNet App Window](pocketnet-app-window.png) + +## Docker Setup + +Ensure that sufficient CPU, memory, and disk space are allocated to your Docker container according to the "Minimum System Requirements" section above. You can start your node with a single command from Docker: + +```bash +$ docker run -d \ + --name=pocketnet.main \ + -p 37070:37070 \ + -p 38081:38081 \ + -p 8087:8087 \ + -v /var/pocketnet/.data:/home/pocketcoin/.pocketcoin \ + pocketnetteam/pocketnet.core:latest +``` + +The node can be controlled in Docker using the `pocketcoin-cli` and `pocketcoin-tx` commands: + +```bash +$ docker ps --format '{{.ID}}\t{{.Names}}\t{{.Image}}' +ea7759a47250 pocketnet.main pocketnetteam/pocketnet.core:latest + +$ docker exec -it pocketnet.main /bin/sh + +$ pocketcoin-cli --help +$ pocketcoin-tx --help +``` + +For more information, visit: https://hub.docker.com/r/pocketnetteam/pocketnet.core + +## Starting Node from a Blockchain Snapshot + +While it's recommended to allow a PocketNet Core node to sync with the blockchain on its own to maximize network security and decentralization, you can use a blockchain snapshot to bring up a node in a shorter time. The development team provides periodic archives of the blockchain, which can be downloaded from https://snapshot.pocketnet.app/latest.tgz. + +> **Important:** Back up your wallet.dat file before attempting to load the blockchain from an archive. + +Use the following Linux bash shell commands to delete the existing blockchain data on disk, download the blockchain archive, and extract it to the default location: + +```bash +$ cd ~/.pocketcoin +$ rm -r blocks +$ rm -r chainstate +$ rm -r indexes +$ rm -r pocketdb +$ wget https://snapshot.pocketnet.app/latest.tgz +$ tar -xzf latest.tgz -C ./ +``` + +## Running a Headless Node From the Command Line + +To start PocketNet core in text-only mode from a command terminal, use the `pocketcoind` command. On Linux, you can launch pocketcoind as a daemon process running in the background by using the -daemon parameter: + +```bash +$ pocketcoind -daemon +``` + +To see other available options with pocketcoind: + +```bash +$ pocketcoind -? +``` + +You can send commands to pocketcoind using the pocketcoin-cli program. These same commands can also be run through the pocketcoin-qt debug terminal. Here are some common and useful commands: + +- Display list of available commands: + ```bash + $ pocketcoin-cli help + ``` + +- Get specific help on a command: + ```bash + $ pocketcoin-cli help "command" + ``` + +- Gracefully shutdown the pocketcoind process: + ```bash + $ pocketcoin-cli stop + ``` + +- Display your current balance of PKOIN: + ```bash + $ pocketcoin-cli getbalance + ``` + +- Generate a new receive address with a descriptive "label": + ```bash + $ pocketcoin-cli getnewaddress "label" + ``` + +- List previously generated or used receive addresses: + ```bash + $ pocketcoin-cli listreceivedbyaddress + ``` + +- Send an amount of PKOIN to an address: + ```bash + $ pocketcoin-cli sendtoaddress "address" amount + ``` + +- View a report of PKOINs won through staking: + ```bash + $ pocketcoin-cli getstakereport + ``` + +- Check if your node is currently staking: + ```bash + $ pocketcoin-cli getstakinginfo + ``` + +- View a list of connected peers: + ```bash + $ pocketcoin-cli getpeerinfo + ``` + +Pocketcoin-cli has the capability to send commands to a remote node for remote management and headless node operation. This is an advanced topic beyond the scope of this guide; however, you can find necessary commands for remote operation by running `pocketcoin-cli --help`. + +## Troubleshooting + +If PocketNet Core fails, the first step is to check the debug.log file in the pocketcoin directory (`~/.pocketcoin` on Linux, `%HOMEPATH%\appdata\roaming\pocketcoin` on Windows). This file often provides clues about what went wrong with the program. + +For help with node setup, post to the Bastyon/Pocknet tag on the Bastion social media app. + +To connect with other node operators and keep up with developments and alerts, join the Node Owners chat on Bastyon. Message SnowflakeCrusher, Vortex_v, or Malaka on Bastyon to be added to the group. + +To report software defects and view current issues, check our [GitHub issues page](https://github.com/pocketnetteam/pocketnet.core/issues). + +## Contributions + +We welcome contributions to our Github projects. We are looking for C/C++ and Javascript Node.js coders, as well as anyone with a willingness to learn. For more information, check out our [contributions'](../../get-started.md) documentation. \ No newline at end of file diff --git a/vuepress-starter/docs/en/user-docs/get-started-user.md b/vuepress-starter/docs/en/user-docs/get-started-user.md new file mode 100644 index 0000000..5951987 --- /dev/null +++ b/vuepress-starter/docs/en/user-docs/get-started-user.md @@ -0,0 +1,174 @@ +# Bastyon Monetization Guide + +## Table of Contents + +1. [Introduction](#introduction) +2. [Advertisers](#advertisers) + - [Benefits](#benefits) + - [How to Start Advertising](#how-to-start-advertising) +3. [Content Creators](#content-creators) + - [How It Works](#how-it-works) + - [Participants and Payouts](#participants-and-payouts) + - [Earnings Withdrawal](#earnings-withdrawal) + - [Payouts Calculation](#payouts-calculation) + - [Ways to Increase Earnings](#ways-to-increase-earnings) +4. [Running a Node and Staking](#running-a-node-and-staking-on-bastyon) + - [Setting Up Your Node](#setting-up-your-node) + - [Staking Process](#staking-process) + - [Managing Your PKOIN](#managing-your-pkoin) +5. [Conclusion](#conclusion) +6. [Appendix](#appendix) + +## Introduction + +Bastyon, a decentralized social media platform, offers various opportunities for users to monetize their content and engagement. This guide outlines the effective ways to make money on Bastyon. + +## Advertisers + +Bastyon offers advertisers access to one of the best CPM (cost per thousand impressions) rates in the industry for large networks. + +### Benefits + +- Competitive CPM: About ¢29 cents compared to the industry average of over $1 +- Reach a new, dynamic audience +- Promote content, including videos +- Lower cost of impressions compared to traditional ad networks + +For detailed CPM calculations, see the [Calculations page](advertisement-cpm-calculation.md). + +
+ +
+ +
+
+
+
    +
  • Are you trying to be heard on the internet?
    • +
  • Would you like to get your content or product in front of a new dynamic audience for less than major ad networks?
    • +
+
+
+
    +
  • Bastyon, the blockchain social network has just released a way of promoting content, including videos.
    • +
  • The cost of an impression on Bastyon is many times lower than on traditional ad networks.
    • +
+
+
+
+ +

Distribution by Country

+ +![alt text](bastyon-usage-distribution-by-country.png) + +

Employment Status

+ +![alt text](bastyon-usage-employment-status.png) + +

Usage Demographics

+ +![alt text](bastyon-usage-audience.png) + +### How to Start Advertising + +1. Prepare an advertising publication (video, post, or article) +2. [Buy PKOIN](buying-pkoin.md) +3. Deposit the required amount of PKOIN to start advertising +4. Click the lightning bolt icon in the lower right corner of the selected post + +![alt text](lightning-bolt-action.png) + +5. Enter PKOIN in the "Amount" field and click "Send" + +![alt text](lift-up-the-post.png) + +**Congratulations! You have launched an advertisement on Bastyon!** + +## Content Creators + +Bastyon believes that content creators should be well compensated for their work. A new advertising and monetization program for bloggers has been launched on the platform. + +### How It Works + +- Advertisers promote products or services on Bastyon +- Ads appear in the main feed and author channels +- Earnings from the main feed go to nodes +- Earnings from author channels go directly to the authors + +### Participants and Payouts + +- Initially, monetization works only on verified author channels +- Authors can disable monetization +- Channels with high activity will be included over time +- Channels outside Bastyon with over 1,000 subscribers can request verification via [email](mailto:support@bastyon.com) + +> **IMPORTANT:** Authors earn proportionally to the activity and number of people on their channel. Higher engagement leads to higher payouts from the advertising pool. + +### Earnings Withdrawal + +Authors can withdraw PKOIN through exchanges like: +- [Tapbit.com](Tapbit.com) +- [Digifinex.com](Digifinex.com) +- [PKOIN.NET](https://pkoin.net) +- Peer-to-peer exchanges in various currencies + +For withdrawal inquiries, contact [support@bastyon.com](mailto:support@bastyon.com). + +### Payouts Calculation + +Earnings vary based on: +- Amount of advertising in a given week +- Advertiser payments +- Channel activity (ratings and comments) + +Active channels can earn the equivalent of $50-75 per week or more. + +### Ways to Increase Earnings + +- Create more content +- Invite more people to engage +- Focus on engagement under posts, not video length + +**Internal economy of Bastyon: Pocketcoin (PKOIN)** + +![monetization-on-bastyon](monetization-on-bastyon.png) + +## Running a Node and Staking on Bastyon + +Users can run a Bastyon node to secure the network and earn PKOIN through staking. + +### Setting Up Your Node + +To begin earning PKOIN: + +1. Download and Install Node Software + - [Full Node Setup Guide](full-node-setup.md) + - [Easy Node Setup Guide](easy-node-setup.md) +2. [Buy PKOIN](buying-pkoin.md) +3. Deposit PKOIN to Your Node Wallet (minimum 50 PKOIN) + +### Staking Process + +Once your node is set up and funded, you can start staking. + +#### Staking Status + +To get staking status: + +- Full Node: Run `getstakinginfo` command +- Easy Node: Check the Node section in your Bastyon app + +### Managing Your PKOIN + +- Sending PKOIN: Use the "Send" function in the Pocketcoin application +- Receiving PKOIN: Generate a payment request with a QR code in the "Receive" section + +## Conclusion + +By participating in Bastyon's ecosystem through advertising, content creation, or running a node, users can earn PKOIN while contributing to a decentralized platform. + +## Appendix + +### [Full Node Setup Guide](full-node-setup.md) + +### [Easy Node Setup Guide](easy-node-setup.md) \ No newline at end of file diff --git a/vuepress-starter/docs/en/user-docs/lift-up-the-post.png b/vuepress-starter/docs/en/user-docs/lift-up-the-post.png new file mode 100644 index 0000000..b7ab054 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/lift-up-the-post.png differ diff --git a/vuepress-starter/docs/en/user-docs/lightning-bolt-action.png b/vuepress-starter/docs/en/user-docs/lightning-bolt-action.png new file mode 100644 index 0000000..09b86ae Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/lightning-bolt-action.png differ diff --git a/vuepress-starter/docs/en/user-docs/monetization-on-bastyon.png b/vuepress-starter/docs/en/user-docs/monetization-on-bastyon.png new file mode 100644 index 0000000..640e055 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/monetization-on-bastyon.png differ diff --git a/vuepress-starter/docs/en/user-docs/pocketnet-app-window.png b/vuepress-starter/docs/en/user-docs/pocketnet-app-window.png new file mode 100644 index 0000000..6dca8a7 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/pocketnet-app-window.png differ diff --git a/vuepress-starter/docs/en/user-docs/pocketnet-network-synchronization.png b/vuepress-starter/docs/en/user-docs/pocketnet-network-synchronization.png new file mode 100644 index 0000000..eab6497 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/pocketnet-network-synchronization.png differ diff --git a/vuepress-starter/docs/en/user-docs/semrush-bastyon-data.png b/vuepress-starter/docs/en/user-docs/semrush-bastyon-data.png new file mode 100644 index 0000000..4fd2e37 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/semrush-bastyon-data.png differ diff --git a/vuepress-starter/docs/en/user-docs/setup-wizzard.png b/vuepress-starter/docs/en/user-docs/setup-wizzard.png new file mode 100644 index 0000000..1513aa1 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/setup-wizzard.png differ diff --git a/vuepress-starter/docs/en/user-docs/tapbit.png b/vuepress-starter/docs/en/user-docs/tapbit.png new file mode 100644 index 0000000..a363bff Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/tapbit.png differ diff --git a/vuepress-starter/docs/en/user-docs/welcome-path-setup.png b/vuepress-starter/docs/en/user-docs/welcome-path-setup.png new file mode 100644 index 0000000..278c5a9 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/welcome-path-setup.png differ diff --git a/vuepress-starter/docs/en/user-docs/windows-security-alert.png b/vuepress-starter/docs/en/user-docs/windows-security-alert.png new file mode 100644 index 0000000..3c74723 Binary files /dev/null and b/vuepress-starter/docs/en/user-docs/windows-security-alert.png differ diff --git a/vuepress-starter/docs/get-started.md b/vuepress-starter/docs/get-started.md new file mode 100644 index 0000000..38e4b86 --- /dev/null +++ b/vuepress-starter/docs/get-started.md @@ -0,0 +1,83 @@ + +#

Get Started

+ +## Overview + +Bastyon is an innovative, open-source social network and video sharing platform designed to prioritize freedom of speech and user privacy. Unlike mainstream social networks, Bastyon operates without centralized corporate control, instead relying on a distributed network of nodes worldwide. + +> **Vision:** +Bastyon aims to create a resilient, decentralized ecosystem that empowers individuals with unrestricted access to communication, information, and personal data management. Our vision is to build a platform that stands strong against censorship and ensures user sovereignty in the digital realm. + + +Key Features: + +1. Decentralized Architecture + + Bastyon's infrastructure is built on a global network of nodes, ensuring continuous accessibility and resilience against censorship attempts. + +2. Anonymity and Privacy + + Users can register without providing personal information such as email addresses or phone numbers. Bastyon does not store IP or MAC addresses, safeguarding user identities from potential tracking or surveillance. + +3. Censorship Resistance + + By design, Bastyon enables users to connect, view content, and post freely as long as they have an internet connection, without fear of content removal or account suspension due to ideological differences. + +4. Open-Source Development + + A team of dedicated developers and experts collaboratively maintain and improve the platform, fostering transparency and community involvement. + +5. Cryptocurrency Integration + + Bastyon incorporates its own cryptocurrency, facilitating secure and decentralized transactions within the platform. + +Founded by Daniel Satchkov, Bastyon aims to provide a secure, anonymous social platform where users can communicate and share content without the risk of corporate or government interference. This commitment to digital freedom sets Bastyon apart in the landscape of social media. + +For more information about Bastyon's vision and the team behind it, you can find interviews with Daniel Satchkov on various platforms, including YouTube and Odysee. + +Join Bastyon today and experience a social network that truly puts your freedom and privacy first. + + +## Quick Start Guide + +### Installation +Bastyion is available on major desktop and mobile platforms. To quickly get started, you can download Bastyon app for your most favorite platform or use an internet browser. + +| Desktop | Mobile | Web| +|----------|---------------------------------------------|-------------------------------------------------| +| [Linux](https://bastyon.com/about?id=about-download) | [Android](https://bastyon.com/about?id=about-download) | [Web Browser](https://bastyon.com/registration) | +| [MacOS](https://bastyon.com/about?id=about-download) | [iOS](https://bastyon.com/about?id=about-download) | | +| [Windows](https://bastyon.com/about?id=about-download) | | + + +### Contribution + +This project exists, thanks to the dedication of people who are passionate about liberating communications across the globe. Whether you are an engineer, an author, a community advocate, or just a believer, we would love your help with this project! Here are a few resources to help you with any questions you may have. +Here are a few resorces. + +- You can reach out to us on [GitHub](https://github.com/pocketnetteam) +- We are also just one [an email](mailto:support@pocketnet.app) + + + +### Documentation + +To learn more about Bastyon's technical details, please check out our extensive [Technical Documentation](/en/dev-docs/get-started-dev.md). + + +## How to Leave Feedback on Bastyon + +You can provide feedback either through [GitHub](https://github.com/pocketnetteam), or [Shoot us an email](mailto:support@pocketnet.app). + +Alternativey, feel free to comment at the bottom of the page. + + +## FAQs + +Please visit our [FAQ](https://bastyon.com/about?id=about-faq) page for commonly asked questions. + + diff --git a/vuepress-starter/package.json b/vuepress-starter/package.json new file mode 100644 index 0000000..09f5a1f --- /dev/null +++ b/vuepress-starter/package.json @@ -0,0 +1,21 @@ +{ + "name": "vuepressdocs", + "version": "0.0.1", + "description": "A VuePress project", + "license": "MIT", + "type": "module", + "scripts": { + "docs:build": "vuepress build docs", + "docs:clean-dev": "vuepress dev docs --clean-cache", + "docs:dev": "vuepress dev docs", + "docs:update-package": "npx vp-update" + }, + "devDependencies": { + "@vuepress/bundler-vite": "^2.0.0-rc.7", + "@vuepress/theme-default": "^2.0.0-rc.11", + "sass-embedded": "^1.79.3", + "vue": "^3.4.0", + "vuepress": "^2.0.0-rc.7", + "vuepress-plugin-mathjax": "^1.2.8" + } +}