From c6ecf51ad1022729732530fd979e36fd3448d44e Mon Sep 17 00:00:00 2001 From: epoberezkin Date: Thu, 7 Mar 2024 15:41:28 +0000 Subject: [PATCH] deploy: 9ff11f886ecb5da3231309d6cbc4ed1c3fbe74df --- docs/server.html | 81 ++++++++++++++++++++++++++++++++++++------ docs/xftp-server.html | 63 +++++++++++++++++++++++++++++++- finneyforum/index.html | 21 +++++++++++ 3 files changed, 153 insertions(+), 12 deletions(-) create mode 100644 finneyforum/index.html diff --git a/docs/server.html b/docs/server.html index ffcb771b45..545bbff5b8 100644 --- a/docs/server.html +++ b/docs/server.html @@ -773,7 +773,7 @@ window.addEventListener('scroll',changeHeaderBg);

SimpleX clients only determine which server is used to receive the messages, separately for each contact (or group connection with a group member), and these servers are only temporary, as the delivery address can change.

Please note: when you change the servers in the app configuration, it only affects which server will be used for the new contacts, the existing contacts will not automatically move to the new servers, but you can move them manually using "Change receiving address" button in contact/member information pages – it will be automated soon.

Installation

-
    +
    1. First, install smp-server:

    Manual installation requires some preliminary actions:

    -
      +
      1. Install binary:

        • Using offical binaries:

          -
          curl -L https://github.com/simplex-chat/simplexmq/releases/latest/download/smp-server-ubuntu-20_04-x86-64 -o /usr/local/bin/smp-server
          +
          curl -L https://github.com/simplex-chat/simplexmq/releases/latest/download/smp-server-ubuntu-20_04-x86-64 -o /usr/local/bin/smp-server && chmod +x /usr/local/bin/smp-server
           
        • @@ -1114,13 +1114,15 @@ Nov 23 19:23:21 5588ab759e80 smp-server[30878]: creating new queues requires pas
        • Allow local mode by appending following:

          +
        • +
      [plugin.marcusolsson-csv-datasource]
       allow_local_mode = true
       

      ... to /etc/grafana/grafana.ini

      - -
    1. -

      Add a CSV data source:

      +
        +
      1. Add a CSV data source:
      2. +
      • In the side menu, click the Configuration tab (cog icon)
      • Click Add data source in the top-right corner of the Data Sources tab
      • @@ -1128,12 +1130,69 @@ allow_local_mode = true
      • Click the search result that says "CSV"
      • In URL, enter a file that points to CSV content
      -
    2. -
    3. -

      You're done! You should be able to create your own dashboard with statistics.

      -
    4. +
        +
      1. You're done! You should be able to create your own dashboard with statistics.

      For further documentation, see: CSV Data Source for Grafana - Documentation

      +

      Updating your SMP server

      +

      To update your smp-server to latest version, choose your installation method and follow the steps:

      +
        +
      • +

        Manual deployment

        +
          +
        1. Stop the server:
          sudo systemctl stop smp-server
          +
          +
        2. +
        3. Update the binary:
           curl -L https://github.com/simplex-chat/simplexmq/releases/latest/download/smp-server-ubuntu-20_04-x86-64 -o /usr/local/bin/smp-server && chmod +x /usr/local/bin/smp-server
          +
          +
        4. +
        5. Start the server:
          sudo systemctl start smp-server
          +
          +
        6. +
        +
      • +
      • +

        Offical installation script

        +
          +
        1. Execute the followin command:
          sudo simplex-servers-update
          +
          +
        2. +
        3. Done!
        4. +
        +
      • +
      • +

        Docker container

        +
          +
        1. Stop and remove the container:
          docker rm $(docker stop $(docker ps -a -q --filter ancestor=simplexchat/smp-server --format="\{\{.ID\}\}"))
          +
          +
        2. +
        3. Pull latest image:
          docker pull simplexchat/smp-server:latest
          +
          +
        4. +
        5. Start new container:
          docker run -d \
          +  -p 5223:5223 \
          +  -v $HOME/simplex/smp/config:/etc/opt/simplex:z \
          +  -v $HOME/simplex/smp/logs:/var/opt/simplex:z \
          +  simplexchat/smp-server:latest
          +
          +
        6. +
        +
      • +
      • +

        Linode Marketplace

        +
          +
        1. Pull latest images:
          docker-compose --project-directory /etc/docker/compose/simplex pull
          +
          +
        2. +
        3. Restart the containers:
          docker-compose --project-directory /etc/docker/compose/simplex up -d --remove-orphans
          +
          +
        4. +
        5. Remove obsolete images:
          docker image prune
          +
          +
        6. +
        +
      • +

      Configuring the app to use the server

      To configure the app to use your messaging server copy it's full address, including password, and add it to the app. You have an option to use your server together with preset servers or without them - you can remove or disable them.

      It is also possible to share the address of your server with your friends by letting them scan QR code from server settings - it will include server password, so they will be able to receive messages via your server as well.

      diff --git a/docs/xftp-server.html b/docs/xftp-server.html index 73d7a5628c..656a4d671c 100644 --- a/docs/xftp-server.html +++ b/docs/xftp-server.html @@ -708,6 +708,7 @@ window.addEventListener('scroll',changeHeaderBg); @@ -720,7 +721,7 @@ window.addEventListener('scroll',changeHeaderBg);
      • Using offical binaries:

        -
        curl -L https://github.com/simplex-chat/simplexmq/releases/latest/download/xftp-server-ubuntu-20_04-x86-64 -o /usr/local/bin/xftp-server
        +
        curl -L https://github.com/simplex-chat/simplexmq/releases/latest/download/xftp-server-ubuntu-20_04-x86-64 -o /usr/local/bin/xftp-server && chmod +x /usr/local/bin/xftp-server
         
      • @@ -1063,6 +1064,66 @@ allow_local_mode = true

    For further documentation, see: CSV Data Source for Grafana - Documentation

    +

    Updating your XFTP server

    +

    To update your XFTP server to latest version, choose your installation method and follow the steps:

    +
      +
    • +

      Manual deployment

      +
        +
      1. Stop the server:
        sudo systemctl stop xftp-server
        +
        +
      2. +
      3. Update the binary:
         curl -L https://github.com/simplex-chat/simplexmq/releases/latest/download/xftp-server-ubuntu-20_04-x86-64 -o /usr/local/bin/xftp-server && chmod +x /usr/local/bin/xftp-server
        +
        +
      4. +
      5. Start the server:
        sudo systemctl start xftp-server
        +
        +
      6. +
      +
    • +
    • +

      Offical installation script

      +
        +
      1. Execute the followin command:
        sudo simplex-servers-update
        +
        +
      2. +
      3. Done!
      4. +
      +
    • +
    • +

      Docker container

      +
        +
      1. Stop and remove the container:
        docker rm $(docker stop $(docker ps -a -q --filter ancestor=simplexchat/xftp-server --format="\{\{.ID\}\}"))
        +
        +
      2. +
      3. Pull latest image:
        docker pull simplexchat/xftp-server:latest
        +
        +
      4. +
      5. Start new container:
        docker run -d \
        +  -p 443:443 \
        +  -v $HOME/simplex/xftp/config:/etc/opt/simplex-xftp:z \
        +  -v $HOME/simplex/xftp/logs:/var/opt/simplex-xftp:z \
        +  -v $HOME/simplex/xftp/files:/srv/xftp:z \
        +  simplexchat/xftp-server:latest
        +
        +
      6. +
      +
    • +
    • +

      Linode Marketplace

      +
        +
      1. Pull latest images:
        docker-compose --project-directory /etc/docker/compose/simplex pull
        +
        +
      2. +
      3. Restart the containers:
        docker-compose --project-directory /etc/docker/compose/simplex up -d --remove-orphans
        +
        +
      4. +
      5. Remove obsolete images:
        docker image prune
        +
        +
      6. +
      +
    • +

    Configuring the app to use the server

    Please see: SMP Server: Configuring the app to use the server.

    diff --git a/finneyforum/index.html b/finneyforum/index.html new file mode 100644 index 0000000000..a695d6b2ca --- /dev/null +++ b/finneyforum/index.html @@ -0,0 +1,21 @@ + + + + + + + SimpleX Chat - Finney Forum group + + + + + + + + + + + +

    Open Finney Forum group link

    + +