Start9/documentation
2
0
Fork 0
mirror of https://github.com/Start9Labs/documentation.git synced 2026-03-30 04:01:59 +00:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #192 from Start9Labs/update/dev-docs

Browse Source 
Minor fixes to flashing guide
This commit is contained in:
kn0wmad
2022-11-06 15:52:56 -07:00
committed by GitHub
parent d756d70d5a b670d46532
commit d7a1701566
2 changed files with 13 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
site/source/developer-docs/packaging.rst
View File

@@ -40,7 +40,7 @@ Almost any type of open source software can be run on embassyOS. No matter what
- The interfaces supported are: HTTP, TCP, and REST APIs - The interfaces supported are: HTTP, TCP, and REST APIs
#. It can be compiled for ARM (``arm64v8``) #. It can be compiled for ARM (``arm64v8`` - namely, the Raspberry Pi) and/or x86_64 (``amd64`` - most desktops, laptops, and servers)
#. It can be served over TOR #. It can be served over TOR
#. It creates a container image that is optimized for size (under 1GB) to save device space and expedite installation time #. It creates a container image that is optimized for size (under 1GB) to save device space and expedite installation time
@@ -199,7 +199,7 @@ After coding the build steps, build the Docker image using ``docker buildx``, re
docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --platform=linux/arm64 -o type=docker,dest=image.tar . docker buildx build --tag start9/$(PKG_ID)/main:$(PKG_VERSION) --platform=linux/arm64 -o type=docker,dest=image.tar .
The resulting ``image.tar`` artifact is the Docker image that needs to be included in the ``s9pk`` package. The resulting ``docker-images/aarch64.tar`` or ``docker-images/x86_64.tar`` artifact (depending on if you used ``--platform=linux/arm64`` or ``--platform=linux/amd64`` is the Docker image that needs to be included in the ``s9pk`` package.
.. _create-file-structure: .. _create-file-structure:

26
site/source/user-manual/flashing.rst
View File

@@ -16,41 +16,37 @@ Extracting the image
Linux Linux
===== =====
#. Download the ``eos.tar.gz`` file and open a terminal in the directory you save it to #. Download the ``eos.tar.gz`` file and open a terminal in the directory you save it to
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
.. code-block::
sha256sum eos.img.gz
#. Extract with: #. Extract with:
.. code-block:: .. code-block::
tar -xzvf eos.img.gz tar -xzvf eos.tar.gz
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
.. code-block::
sha256sum eos.img
Mac Mac
=== ===
#. Download the ``eos.tar.gz`` file #. Download the ``eos.tar.gz`` file
#. Right-click eos.tar.gz, click "open with," then click Archive Utility to extract
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub: #. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
.. code-block:: .. code-block::
openssl dgst -sha256 eos.img.gz openssl dgst -sha256 eos.img
#. Right-click eos.tar.gz, click "open with," then click Archive Utility to extract
Windows Windows
======= =======
#. Download the ``eos.zip`` file #. Download the ``eos.zip`` file
#. Right-click eos.zip and click "Extract all"
#. (Optional, but recommended) Verify the checksum against the one listed on GitHub: #. (Optional, but recommended) Verify the checksum against the one listed on GitHub:
.. code-block:: .. code-block::
Get-FileHash eos.zip Get-FileHash eos.img
#. Right-click eos.zip and click "Extract all"
In all cases you will be left with the file ``eos.img``
Installing embassyOS Installing embassyOS
-------------------- --------------------