Local version of asteroidos.org - Revision history

MagneFire: Newline fixes

2024-01-04T14:31:06Z

Newline fixes

← Older revision		Revision as of 14:31, 4 January 2024
Line 1:		Line 1:
	[[Category:Developers]]		[[Category:Developers]]
	This web site can be built and run locally within a software container, such as those created by ''container engines'' like [https://www.docker.com/ Docker] or [https://podman.io/ podman]. One reason for doing this is to be able to install and build the documentation without having to load the collection of tools on your real computer. Building and running a documentation server in a local container is the topic of this page.\		This web site can be built and run locally within a software container, such as those created by ''container engines'' like [https://www.docker.com/ Docker] or [https://podman.io/ podman]. One reason for doing this is to be able to install and build the documentation without having to load the collection of tools on your real computer. Building and running a documentation server in a local container is the topic of this page.

	This documentation will use <code>podman</code>, but the commands for <code>docker</code> are identical. If you wish to use <code>docker</code> instead of <code>podman</code>, just substitute <code>docker</code> for <code>podman</code> in each of the commands shown below.		This documentation will use <code>podman</code>, but the commands for <code>docker</code> are identical. If you wish to use <code>docker</code> instead of <code>podman</code>, just substitute <code>docker</code> for <code>podman</code> in each of the commands shown below.

	= Rootless setup =		= Rootless setup =

	In case the commands described in the next sections fail, try to either prepend <code>sudo</code> to them or log in as root via e.g <code>su root</code>.\		In case the commands described in the next sections fail, try to either prepend <code>sudo</code> to them or log in as root via e.g <code>su root</code>.

	You can manually set up rootless container use on a Linux distribution that has not automatically done this for you while installing the container engine, by following the official instructions.		You can manually set up rootless container use on a Linux distribution that has not automatically done this for you while installing the container engine, by following the official instructions.
	*[https://docs.docker.com/engine/security/rootless/ How to install docker in rootless mode] is described in the docker documentation.		*[https://docs.docker.com/engine/security/rootless/ How to install docker in rootless mode] is described in the docker documentation.

Beroset: added category

2023-06-26T17:49:39Z

added category

← Older revision		Revision as of 17:49, 26 June 2023
Line 1:		Line 1:
			[[Category:Developers]]
	This web site can be built and run locally within a software container, such as those created by ''container engines'' like [https://www.docker.com/ Docker] or [https://podman.io/ podman]. One reason for doing this is to be able to install and build the documentation without having to load the collection of tools on your real computer. Building and running a documentation server in a local container is the topic of this page.\		This web site can be built and run locally within a software container, such as those created by ''container engines'' like [https://www.docker.com/ Docker] or [https://podman.io/ podman]. One reason for doing this is to be able to install and build the documentation without having to load the collection of tools on your real computer. Building and running a documentation server in a local container is the topic of this page.\
	This documentation will use <code>podman</code>, but the commands for <code>docker</code> are identical. If you wish to use <code>docker</code> instead of <code>podman</code>, just substitute <code>docker</code> for <code>podman</code> in each of the commands shown below.		This documentation will use <code>podman</code>, but the commands for <code>docker</code> are identical. If you wish to use <code>docker</code> instead of <code>podman</code>, just substitute <code>docker</code> for <code>podman</code> in each of the commands shown below.

Beroset: initial version of local version

2023-06-17T17:15:48Z

initial version of local version

New page

This web site can be built and run locally within a software container, such as those created by ''container engines'' like [https://www.docker.com/ Docker] or [https://podman.io/ podman]. One reason for doing this is to be able to install and build the documentation without having to load the collection of tools on your real computer. Building and running a documentation server in a local container is the topic of this page.\
This documentation will use <code>podman</code>, but the commands for <code>docker</code> are identical. If you wish to use <code>docker</code> instead of <code>podman</code>, just substitute <code>docker</code> for <code>podman</code> in each of the commands shown below.

= Rootless setup =

In case the commands described in the next sections fail, try to either prepend <code>sudo</code> to them or log in as root via e.g <code>su root</code>.\
You can manually set up rootless container use on a Linux distribution that has not automatically done this for you while installing the container engine, by following the official instructions.
*[https://docs.docker.com/engine/security/rootless/ How to install docker in rootless mode] is described in the docker documentation.
*Podman can be used rootless by users that have a UID/GID range defined. This can be done using the following command for your USERNAME, as [https://github.com/containers/podman/blob/main/docs/tutorials/rootless_tutorial.md described in the podman documentation].
<pre>
sudo usermod --add-subuids 100000-165535 --add-subgids 100000-165535 USERNAME
</pre>

= Building the web site =

<pre>
podman build -t asteroidos-web \
https://raw.githubusercontent.com/AsteroidOS/asteroidos.org/master/Dockerfile
</pre>

This will create an <code>asteroidos-web</code> image which is only around 236 MB and based on the Alpine Linux distribution.

= Running locally =

This section describes how to make changes to the documentation locally and try them out in a container.

Create a local version of this repository with <code>git clone https://github.com/AsteroidOS/asteroidos.org.git</code>. Then go into that directory with <code>cd asteroidos.org</code>.

This will start the container and run it in the background with the tag <code>asteroidos-web</code>.

<pre>
podman run --rm --detach \
--name asteroidos-web \
--publish 8080:80 \
--volume "$(pwd)":/tmp/asteroidos.org:z \
asteroidos-web
</pre>

After the initial clone of <code>asteroidos.org</code> you need to install the node dependencies first before <code>grunt</code> works

<pre>
podman exec asteroidos-web npm install
</pre>

This will rebuild the website and you will be able to see it by pointing your browser to <code>localhost:8080/</code>.

<pre>
podman exec asteroidos-web grunt
</pre>

If you decide to make changes to your copy of the website, you can make the changes and then rebuild by running <code>grunt</code> again within the container.

== Running the unmodified version ==

'''Note:''' if you want to simply run and view the unmodified version, you can simply use:

<pre>
podman run --rm --detach --publish 8080:80 asteroidos-web
</pre>

This will run the version of the website within the container that existed when the container was constructed.