User:Bipface - Revision history

Bipface: Blanked the page

2020-03-04T13:24:30Z

Blanked the page

← Older revision		Revision as of 13:24, 4 March 2020
Line 1:		Line 1:
	~~(draft)~~

	~~==Prerequisites==~~

	* Basic familiarity with Linux.

	* A Linux server running '''Debian version 9''' (''Stretch'') or newer, or '''Ubuntu version 16''' (''Xenial Xerus'') or newer.<br>To use earlier versions you will need to determine how to install a '''Java 8''' runtime, which may not be a straightforward process and is beyond the scope of this guide.

	* Root access to your server (i.e. <code>su</code>/<code>sudo</code>).

	* PuTTY or any other SSH program to connect to your server. This allows for copying/pasting of commands.

	* One or more 'active' [https://e-hentai.org/hentaiathome.php Hentai@Home Clients] on your account.

	* An open port through which the client can accept connections from the internet, as explained in the [[Hentai@Home#Minimum Requirements\|minimum requirements]] section.<br>In particular, you may need to choose a port number greater than 1023 to avoid having to run the client as root.

	* This guide assumes a server-style environment, typical of VPS/cloud-hosted systems. Installation on desktop or IoT systems, for example, may require doing some things differently.

	~~===Optional Tools===~~

	~~To perform the installation, you may also require the following:~~

	* A command-line HTTP client such as <code>wget</code> or <code>curl</code>.

	* A zip-file extractor such as <code>unzip</code>.

	* A text editor such as <code>nano</code> or <code>vi</code>.

	~~On some distributions, such as ''Minimal Ubuntu'', standard command-line tools might not be present by default. Use <code># apt install</code> to install these packages as needed.~~

	~~===Take Note===~~

	* Linux is case-sensitive with file names. Therefore, it is best to use lowercase names everywhere to make it easier for yourself.

	* Commands starting with '''$''' are to be run as current user, those starting with '''#''' as root.

	* Before installing packages, refresh the package manager by running <code># apt update</code>.

	* H@H 1.6.0 and above uses SSL certificates. For them to work properly, you need the '''ntp''' package, which keeps the server's date and time in sync. It is normally installed by default.

	~~==Overview==~~

	~~At a glance, the steps to install H@H are as follows, with further details in the subsequent sections:~~

	* Install a Java version 8 (or newer) runtime environment.

	* Obtain and configure the latest H@H client software.

	* Define a service (systemd ''unit file'') to run it.

	~~==Installing Java==~~

	~~Start by checking whether a Java runtime is already available by running:~~
	~~<pre>$ java -version</pre>~~
	~~A result such as <code>openjdk version "1.8.0_242"</code>, where the version number is 1.8 or greater, indicates that your server has a suitable Java runtime and you can skip to the next section.~~

	~~If you see a result such as <code>java: command not found</code>, no Java runtime is installed yet.~~

	~~Examine the default JRE package:~~
	~~<pre># apt show default-jre-headless</pre>~~
	You should expect to find a line in the output such as <code>Depends: '''openjdk-8'''-jre-headless, java-common</code>. If '''openjdk-7''' or lower is listed instead, your OS version may be too old to install a Java 8 runtime by conventional means — refer to the [[#Prerequisites\|Prerequisites]] section.

	~~Install the JRE:~~
	~~<pre># apt install default-jre-headless</pre>~~
	If you're planning to use H@H in GUI mode at any point, you should instead install the package <code>default-jre</code> (without the ''-headless'' suffix). Otherwise, the headless package will suffice.

	~~Once complete, run <code>$ java -version</code> again to verify the result.~~

	~~==Preparing the H@H Client==~~

	~~It is recommended to create a dedicated service account to run the H@H client.<br>This is achieved with the command:~~
	~~<pre># adduser hath</pre>~~

	Login as the newly created user, then download and extract the H@H client software:<br>(Replace <code>VERSION</code> with the version number of the latest release, which can be found on the [https://e-hentai.org/hentaiathome.php Hentai@Home Clients] page)
	~~<pre># login hath~~
	~~$ wget 'https://repo.e-hentai.org/hath/HentaiAtHome_VERSION.zip'~~
	~~$ unzip HentaiAtHome_VERSION.zip</pre>~~

	~~Launch the client by running:~~
	~~<pre>$ java -jar HentaiAtHome.jar</pre>~~
	~~You should be prompted to enter your ''Client ID'' and ''Client Key'', which can be found on the [https://e-hentai.org/hentaiathome.php Hentai@Home Clients] page.~~

	~~Once the client has successfully authenticated with the server, press <code>ctrl+C</code> to quit the client, then proceed to the next section.~~

	~~==Defining the H@H Service==~~

	~~Use the following command to create a new ''unit file'' defining the service:~~
	~~<pre># systemctl edit hath.service --full --force</pre>~~

	~~Insert the following text and save the file:~~
	~~<pre>[Unit]~~
	~~Description=Hentai@Home~~
	~~After=local-fs.target remote-fs.target network.target~~

	~~[Service]~~
	~~Type=simple~~
	~~User=hath~~
	~~WorkingDirectory=/home/hath~~
	~~SuccessExitStatus=143~~
	~~ExecStart=/usr/bin/java -jar HentaiAtHome.jar~~
	~~Restart=on-failure~~

	~~[Install]~~
	~~WantedBy=multi-user.target</pre>~~
	~~(The line <code>SuccessExitStatus=143</code> is needed because the Java process may return a non-zero exit code even after a graceful shutdown).~~

	~~Now start the service:~~
	~~<pre># systemctl start hath</pre>~~

	~~==Testing and Monitoring==~~

	~~You can see the current status of your H@H service by running:~~
	~~<pre># systemctl status hath</pre>~~
	~~The output should indicate whether the service is active, and shows the last few lines of console output from the H@H process itself.~~

	~~You can also read the two log files <code>log_out</code> and <code>log_err</code>, which are found in <code>/home/hath/log/</code>.~~

	One way to confirm that the client is listening for connections is to open <code>https://ADDRESS:PORT/robots.txt</code> in a web browser, where <code>PORT</code> is the port number configured for the client and <code>ADDRESS</code> is the internet-facing IP address of your server. If the connection is established the browser will most likely present a HTTPS certificate error – bypass the error and a text file should be served to you.

	~~==See also==~~
	*[[Hentai@Home]]

	~~[[Category:E-Hentai Galleries]]~~

Bipface: /* Testing and Monitoring */

2020-03-04T13:18:19Z

Testing and Monitoring

← Older revision		Revision as of 13:18, 4 March 2020
Line 116:		Line 116:
	You can also read the two log files <code>log_out</code> and <code>log_err</code>, which are found in <code>/home/hath/log/</code>.		You can also read the two log files <code>log_out</code> and <code>log_err</code>, which are found in <code>/home/hath/log/</code>.

	One way to confirm that the client is listening for connections is to open <code>https://ADDRESS:PORT/robots.txt</code> in a web browser, where <code>PORT</code> is the port number configured for the client and <code>ADDRESS</code> is the internet-facing IP address of your server.~~<br>~~If the connection is established the browser will most likely present a HTTPS certificate error – bypass the error and a text file should be served to you.		One way to confirm that the client is listening for connections is to open <code>https://ADDRESS:PORT/robots.txt</code> in a web browser, where <code>PORT</code> is the port number configured for the client and <code>ADDRESS</code> is the internet-facing IP address of your server. If the connection is established the browser will most likely present a HTTPS certificate error – bypass the error and a text file should be served to you.

	==See also==		==See also==

Bipface: /* Overview */

2020-03-04T13:16:14Z

Overview

← Older revision		Revision as of 13:16, 4 March 2020
Line 47:		Line 47:
	* Obtain and configure the latest H@H client software.		* Obtain and configure the latest H@H client software.

	* Define a service (systemd 'unit' ~~file~~) to run it.		* Define a service (systemd ''unit file'') to run it.

	==Installing Java==		==Installing Java==

Bipface: /* Take Note */

2020-03-04T13:15:06Z

Take Note

← Older revision		Revision as of 13:15, 4 March 2020
Line 37:		Line 37:
	* Before installing packages, refresh the package manager by running <code># apt update</code>.		* Before installing packages, refresh the package manager by running <code># apt update</code>.

	* H@H 1.6.0 and above uses SSL certificates. For them to work properly, you need the '''ntp''' package ~~(it syncs~~ the server's date and time). It is normally installed by default~~, but package updates might cause it to fail~~.		* H@H 1.6.0 and above uses SSL certificates. For them to work properly, you need the '''ntp''' package, which keeps the server's date and time in sync. It is normally installed by default.

	==Overview==		==Overview==

Bipface: /* Take Note */

2020-03-04T13:13:37Z

Take Note

← Older revision		Revision as of 13:13, 4 March 2020
Line 37:		Line 37:
	* Before installing packages, refresh the package manager by running <code># apt update</code>.		* Before installing packages, refresh the package manager by running <code># apt update</code>.

	* H@H 1.6.0 and above uses SSL certificates. For them to work properly, you need the '''ntp''' package (it syncs the server's date and time). It is normally installed by default, but package updates ~~may make~~ it fail.		* H@H 1.6.0 and above uses SSL certificates. For them to work properly, you need the '''ntp''' package (it syncs the server's date and time). It is normally installed by default, but package updates might cause it to fail.

	==Overview==		==Overview==

Bipface: /* Optional Tools */

2020-03-04T13:12:21Z

Optional Tools

← Older revision		Revision as of 13:12, 4 March 2020
Line 27:		Line 27:
	* A text editor such as <code>nano</code> or <code>vi</code>.		* A text editor such as <code>nano</code> or <code>vi</code>.

	On some distributions, such as ''Minimal Ubuntu'', standard command-line tools might not be present by default. Use <code>apt</code> to install these packages as needed.		On some distributions, such as ''Minimal Ubuntu'', standard command-line tools might not be present by default. Use <code># apt install</code> to install these packages as needed.

	===Take Note===		===Take Note===

Bipface at 13:11, 4 March 2020

2020-03-04T13:11:00Z

← Older revision		Revision as of 13:11, 4 March 2020
Line 108:		Line 108:
	<pre># systemctl start hath</pre>		<pre># systemctl start hath</pre>

	==~~Installing H@H==~~		==Testing and Monitoring==

	~~For more security let's create new user for H@H:~~
	~~<pre<includeonly></includeonly> style="overflow: auto;{{{style\|}}}"><FONT COLOR="1FD30D"># adduser <FONT COLOR="35A4D6">hath</FONT></FONT></pre>~~

	~~Now login as the new user~~ and ~~create a directory for H@H client:~~
	~~<pre<includeonly></includeonly> style="overflow: auto;{{{style\|}}}"><FONT COLOR="1FD30D"># login <FONT COLOR="35A4D6">hath</FONT>~~
	~~$ mkdir <FONT COLOR="35A4D6">hath</FONT></FONT></pre>~~

	~~Download H@H (check for the latest version [https://e-hentai.org/hentaiathome.php here]):~~
	~~<pre<includeonly></includeonly> style="overflow: auto;{{{style\|}}}"><FONT COLOR="1FD30D">$ wget https://repo.e-hentai.org/hath/HentaiAtHome_1.4.2.zip</FONT></pre>~~

	~~Unzip the downloaded archive (install unzip if you haven't yet):~~
	~~<pre<includeonly></includeonly> style="overflow: auto;{{{style\|}}}"><FONT COLOR="1FD30D">$ unzip HentaiAtHome_1.4.2.zip -d <FONT COLOR="35A4D6">hath/</FONT></FONT></pre>~~

	~~Well done, let's launch it!~~
	~~<pre<includeonly></includeonly> style="overflow: auto;{{{style\|}}}"><FONT COLOR~~=~~"1FD30D">$ cd <FONT COLOR~~=~~"35A4D6">hath</FONT>~~
	~~$ java -jar HentaiAtHome.jar</FONT></pre>~~

	You ~~will be prompted for your client ID and Password which you~~ can ~~find on [https://e-hentai.org/hentaiathome.php~~ your H@H ~~page]~~		You can see the current status of your H@H service by running:
			<pre># systemctl status hath</pre>
	~~You will need to configure your client settings on~~ the ~~above page before you get your client password. If you have not applied to run a~~ H@H ~~client yet, you will have to do so first.~~		The output should indicate whether the service is active, and shows the last few lines of console output from the H@H process itself.

	~~To stop the server, press "Ctrl+C" and wait for a couple seconds~~.

	~~==Testing and Monitoring==~~
	~~(todo)~~

	~~https:~~//<ip>:<~~port~~>~~/robots~~.~~txt~~		You can also read the two log files <code>log_out</code> and <code>log_err</code>, which are found in <code>/home/hath/log/</code>.

	~~systemctl status hath~~		One way to confirm that the client is listening for connections is to open <code>https://ADDRESS:PORT/robots.txt</code> in a web browser, where <code>PORT</code> is the port number configured for the client and <code>ADDRESS</code> is the internet-facing IP address of your server.<br>If the connection is established the browser will most likely present a HTTPS certificate error – bypass the error and a text file should be served to you.

	==See also==		==See also==

Bipface: /* Defining the H@H Service */

2020-03-04T12:30:09Z

Defining the H@H Service

← Older revision		Revision as of 12:30, 4 March 2020
Line 85:		Line 85:
	==Defining the H@H Service==		==Defining the H@H Service==

	~~Using your preferred text editor (such as <code>nano</code>),~~ create a new ''unit file'' ~~to define~~ the service:		Use the following command to create a new ''unit file'' defining the service:
	<pre># ~~nano /etc/systemd/system/~~hath.service</pre>		<pre># systemctl edit hath.service --full --force</pre>

	Insert the following text and save the file:		Insert the following text and save the file:
Line 103:		Line 103:
	[Install]		[Install]
	WantedBy=multi-user.target</pre>		WantedBy=multi-user.target</pre>
			(The line <code>SuccessExitStatus=143</code> is needed because the Java process may return a non-zero exit code even after a graceful shutdown).
	~~Ensure the new service is loaded by running:~~
	<~~pre~~>~~# systemctl daemon-reload~~</~~pre~~>

	Now start the service:		Now start the service:

Bipface: /* Optional Tools */

2020-03-04T12:19:33Z

Optional Tools

← Older revision		Revision as of 12:19, 4 March 2020
Line 24:		Line 24:

	* A zip-file extractor such as <code>unzip</code>.		* A zip-file extractor such as <code>unzip</code>.

			* A text editor such as <code>nano</code> or <code>vi</code>.

	On some distributions, such as ''Minimal Ubuntu'', standard command-line tools might not be present by default. Use <code>apt</code> to install these packages as needed.		On some distributions, such as ''Minimal Ubuntu'', standard command-line tools might not be present by default. Use <code>apt</code> to install these packages as needed.

Bipface: /* Prerequisites */

2020-03-04T12:17:41Z

Prerequisites

← Older revision		Revision as of 12:17, 4 March 2020
Line 24:		Line 24:

	* A zip-file extractor such as <code>unzip</code>.		* A zip-file extractor such as <code>unzip</code>.

	* A text editor such as <code>nano</code> or <code>vi</code>.

	On some distributions, such as ''Minimal Ubuntu'', standard command-line tools might not be present by default. Use <code>apt</code> to install these packages as needed.		On some distributions, such as ''Minimal Ubuntu'', standard command-line tools might not be present by default. Use <code>apt</code> to install these packages as needed.