AwesomO: /* Starting Environment */

2025-09-01T19:13:31Z

Starting Environment

← Older revision	Revision as of 19:13, 1 September 2025
Line 1:	Line 1:


		==Docker Image==

		* [[Ubuntu2404_Install_Docker_and_Docker_Compose\| Download the wiki as a '''Docker image''' to run locally on your computer or fork it to contribute and share knowledge.]]

AwesomO: /* Script Details */

2025-06-21T01:52:09Z

Script Details

Show changes

AwesomO: /* Login to Container for Maintenance */

2025-06-21T01:44:03Z

← Older revision		Revision as of 01:44, 21 June 2025
Line 398:		Line 398:

	=== Login to Container for Maintenance ===		=== Login to Container for Maintenance ===
	* Syntax:<code>docker exec -it <~~directory_name>-<service~~>-1 /bin/bash</code>		* Syntax:<code>docker exec -it <container_name_and_service>-1 /bin/bash</code>
	** use:<code>docker container ls</code> to see container and service names.		** use:<code>docker container ls</code> or <code>docker ps</code> to see container and service names.
	<source lang="bash">		<source lang="bash">
	docker exec -it noobwiki-mediawiki-1 /bin/bash		docker exec -it noobwiki-mediawiki-1 /bin/bash

AwesomO at 20:32, 19 February 2025

2025-02-19T20:32:37Z

← Older revision		Revision as of 20:32, 19 February 2025
Line 9:		Line 9:

	== Docker Installation Guide ==		== Docker Installation Guide ==

			<youtube>https://www.youtube.com/watch?v=MheOIG2KiTI</youtube>

	=== Preparation ===		=== Preparation ===

AwesomO: /* Configure User Permissions */

2025-02-17T09:51:33Z

Configure User Permissions

@@ Line 91: / Line 91: @@
 '''Note''': After adding your user to the docker group, you'll need to '''log out and log back in''' for the changes to take effect.
 If you do not log out and back in, Or you do not add your $USER to the docker group, you will be required to use sudo in some cases. such as ..
 = Creating a Wiki and Importing an XML Dump =

AwesomO: Created page with " ==Starting Environment== * '''Hardware''': HP EliteDesk 800 G1 * '''Operating System''': Ubuntu-Mate 24.04 * '''Installation Type''': Fresh Install * '''Initial Setup Post-Install''': Package Update: `sudo apt update && sudo apt upgrade -y` * '''Additional Software''': Installed just to record screen for this tut and not needed `sudo apt install simplescreenrecorder` == Docker Installation Guide == === Preparation === Before we begin, make sure..."

2025-02-16T22:59:11Z

Created page with " ==Starting Environment== * '''Hardware''': HP EliteDesk 800 G1 * '''Operating System''': Ubuntu-Mate 24.04 * '''Installation Type''': Fresh Install * '''Initial Setup Post-Install''': Package Update: <code>sudo apt update && sudo apt upgrade -y</code> * '''Additional Software''': Installed just to record screen for this tut and not needed <code>sudo apt install simplescreenrecorder</code> == Docker Installation Guide == === Preparation === Before we begin, make sure..."

New page

==Starting Environment==
* '''Hardware''': HP EliteDesk 800 G1
* '''Operating System''': Ubuntu-Mate 24.04
* '''Installation Type''': Fresh Install
* '''Initial Setup Post-Install''': Package Update: <code>sudo apt update && sudo apt upgrade -y</code>
* '''Additional Software''': Installed just to record screen for this tut and not needed <code>sudo apt install simplescreenrecorder</code>

== Docker Installation Guide ==

=== Preparation ===

Before we begin, make sure you're logged in with a user account that has sudo privileges.

=== Update System Packages ===

Update your package list to ensure you have the latest versions of packages:

<source lang="bash">
sudo apt update
</source>

=== Install Docker Prerequisites ===

Install the necessary packages for Docker setup:

<source lang="bash">
sudo apt install -y apt-transport-https ca-certificates curl software-properties-common
</source>

=== Setup Docker Repository ===

* '''Add Docker's Official GPG Key''':

<source lang="bash">
curl -fsSL https://download.docker.com/linux/ubuntu/gpg | sudo gpg --dearmor -o /usr/share/keyrings/docker-archive-keyring.gpg
</source>

* '''Add the Docker Repository''':

<source lang="bash">
echo "deb [arch=$(dpkg --print-architecture) signed-by=/usr/share/keyrings/docker-archive-keyring.gpg] https://download.docker.com/linux/ubuntu $(lsb_release -cs) stable" | sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
</source>

=== Install Docker and Docker Compose ===

* '''Update Package List Again''':

<source lang="bash">
sudo apt update
</source>

* '''Install Docker Engine, CLI, Containerd, and Additional Tools''':

<source lang="bash">
sudo apt install -y docker-ce docker-ce-cli containerd.io python3-bs4 python3-requests docker-compose
</source>

* '''Install Docker Compose''':

Here we're downloading the latest version of Docker Compose:

<source lang="bash">
sudo curl -L "https://github.com/docker/compose/releases/latest/download/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
</source>

Make the Docker Compose binary executable:

<source lang="bash">
sudo chmod +x /usr/local/bin/docker-compose
</source>

=== Verify Installation ===

Check if Docker and Docker Compose are installed correctly:

<source lang="bash">
docker --version
docker-compose --version
</source>

=== Configure User Permissions ===

To run Docker commands without <code>sudo</code>, add your user to the <code>docker</code> group:

<source lang="bash">
sudo usermod -aG docker $USER
</source>

'''Note''': After adding your user to the docker group, you'll need to '''log out and log back in''' for the changes to take effect.
If you do not log out and back in, Or you do not add your $USER to the docker group, you will be required to use sudo in some cases. such as ..

= Creating a Wiki and Importing an XML Dump =

== Setup the Wiki Environment ==

=== Create Directory for the Wiki ===
<source lang="bash">
mkdir noobwiki
cd noobwiki
</source>

=== Create Docker Compose File ===
Edit your <code>docker-compose.yml</code> file:

* [[SET$EDITOR|set editor]]
<source lang="bash">
$EDITOR docker-compose.yml
</source>

'''Contents of <code>docker-compose.yml</code>''':
<source lang="yaml">
services:
database:
image: mysql:5.7
environment:
MYSQL_DATABASE: my_wiki
MYSQL_USER: wikiuser
MYSQL_PASSWORD: wikipass
MYSQL_RANDOM_ROOT_PASSWORD: 'yes'
volumes:
- ./mysql_data:/var/lib/mysql

mediawiki:
image: mediawiki
ports:
- 8080:80
links:
- database
volumes:
- ./mediawiki_data:/var/www/html/images
# - ./LocalSettings.php:/var/www/html/LocalSettings.php # This line is commented out initially
</source>

'''Note:''' The <code>LocalSettings.php</code> volume mapping is commented out to prevent automatic creation during initial setup.

== Python Script for Setup and XML Import ==

=== Script Details ===
Create a Python script to automate the setup and import process:

<source lang="bash">
$EDITOR setup_and_import.py
</source>

'''Contents of <code>setup_and_import.py</code>''':
<source lang="python">
import os
import time
import requests
from bs4 import BeautifulSoup
import re
import subprocess
import sys

BASE_URL = "https://xml.completenoobs.com/xmlDumps/"

def get_available_dumps():
response = requests.get(BASE_URL)
soup = BeautifulSoup(response.text, 'html.parser')
dumps = []
for link in soup.find_all('a'):
href = link.get('href')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', href):
dumps.append(href.rstrip('/'))
return sorted(dumps, reverse=True)

def get_dump_files(dump):
response = requests.get(BASE_URL + dump)
soup = BeautifulSoup(response.text, 'html.parser')
files = {}
for link in soup.find_all('a'):
href = link.get('href')
if href.endswith('.xml'):
files[href] = link.next_sibling.strip()
return files

def download_file(url, filename):
response = requests.get(url)
with open(filename, 'wb') as f:
f.write(response.content)

def run_command(command):
process = subprocess.Popen(command, stdout=subprocess.PIPE, stderr=subprocess.PIPE, shell=True)
output, error = process.communicate()
return output.decode(), error.decode(), process.returncode

def setup_mediawiki():
print("Setting up MediaWiki...")
os.system("docker-compose up -d")
time.sleep(10) # Wait for services to start

print("Please complete the MediaWiki installation by visiting http://localhost:8080")
print("Use the following database settings:")
print("Database host: database")
print("Database name: my_wiki")
print("Database username: wikiuser")
print("Database password: wikipass")
input("Press Enter when you have completed the installation and downloaded LocalSettings.php...")

if not os.path.exists('LocalSettings.php'):
print("LocalSettings.php not found. Please place it in the current directory.")
sys.exit(1)

os.system("docker-compose restart mediawiki")
print("MediaWiki setup completed.")

def import_xml_to_mediawiki(xml_file):
command = f"docker-compose exec -T mediawiki php maintenance/importDump.php < {xml_file}"
output, error, return_code = run_command(command)
if return_code != 0:
print(f"Error importing XML: {error}")
sys.exit(1)
print(output)

def main():
if not os.path.exists('LocalSettings.php'):
setup_mediawiki()

dumps = get_available_dumps()
print("Available dumps:")
for i, dump in enumerate(dumps):
print(f"{i + 1}. {dump}")

choice = int(input("Enter the number of the dump you want to download: ")) - 1
selected_dump = dumps[choice]

files = get_dump_files(selected_dump)
xml_file = next(iter(files))

print(f"Downloading {xml_file}...")
download_file(BASE_URL + selected_dump + '/' + xml_file, xml_file)

print("Importing XML dump into MediaWiki...")
import_xml_to_mediawiki(xml_file)
print("Import completed successfully.")

if __name__ == "__main__":
main()</source>

=== Running the Script ===
<source lang="bash">
python3 setup_and_import.py
</source>

<div class="toccolours mw-collapsible mw-collapsed">
'''Terminal Output: when script running at this stage:
<div class="mw-collapsible-content">
<pre>
noob@noob-elite:~/wiki$ python3 setup_and_import.py
Setting up MediaWiki...
WARN[0000] /home/noob/wiki/docker-compose.yml: the attribute `version` is obsolete, it will be ignored, please remove it to avoid potential confusion
[+] Running 33/2
✔ database Pulled 54.0s
✔ mediawiki Pulled 95.0s
[+] Running 3/3
✔ Network wiki_default Created 0.1s
✔ Container wiki-database-1 Started 0.3s
✔ Container wiki-mediawiki-1 Started 0.5s
Please complete the MediaWiki installation by visiting http://localhost:8080
Use the following database settings:
Database host: database
Database name: my_wiki
Database username: wikiuser
Database password: wikipass
Press Enter when you have completed the installation and downloaded LocalSettings.php...
</pre>

</div>
</div>

=== Script Execution Steps ===
* '''Initial Setup:''' The script starts Docker containers and waits for MediaWiki installation.
* '''Manual Steps:'''
** Leave the script terminal running.
** Open a new terminal for further commands.
** Visit <code>http://localhost:8080</code> in your browser to complete the MediaWiki setup using:
*** Database host: <code>database</code>
*** Database name: <code>my_wiki</code>
*** Database username: <code>wikiuser</code>
*** Database password: <code>wikipass</code>
* '''Post Installation:'''
** Download <code>LocalSettings.php</code> from the browser.
** This Downloads to your <code>Downloads</code> directory, move/copy to your <code>noobwiki</code> directory.

** Stop the containers:
*** NOTE: <code>docker-compose</code> commands are ment to be run in direcotry containing the docker-compose.yml file Or you need to use <code>docker-compose -f /path/to/docker-compose.yml down -v</code>
<source lang="bash">
docker-compose down -v
</source>
** Uncomment the <code>LocalSettings.php</code> volume mapping in <code>docker-compose.yml</code>.
<source lang="bash">
$EDITOR docker-compose.yml</source>
<div class="toccolours mw-collapsible mw-collapsed">
<code>docker-compose.yml</code> After uncommenting:
<div class="mw-collapsible-content">
<pre>
services:
database:
image: mysql:5.7
environment:
MYSQL_DATABASE: my_wiki
MYSQL_USER: wikiuser
MYSQL_PASSWORD: wikipass
MYSQL_RANDOM_ROOT_PASSWORD: 'yes'
volumes:
- ./mysql_data:/var/lib/mysql

mediawiki:
image: mediawiki
ports:
- 8080:80
links:
- database
volumes:
- ./mediawiki_data:/var/www/html/images
- ./LocalSettings.php:/var/www/html/LocalSettings.php # This line is commented out initially
</pre>
</div>
</div>
** Restart Docker:
<source lang="bash">
docker-compose up -d
</source>
* '''Return to Script Terminal:'''
** Press Enter to continue with XML dump selection and import.

===Post LocalSettings.php script===

After returning to script and pressing Enter, the script will scan xml.completenoobs.com and give you a list of wiki dumps with a Number on the left and a date.
* Enter number to select a dated xml

<pre>
Press Enter when you have completed the installation and downloaded LocalSettings.php...
[+] Restarting 1/1
✔ Container wiki-mediawiki-1 Started 1.3s
MediaWiki setup completed.
Available dumps:
1. 31_05_23.Noobs
2. 30_03_23.Noobs
3. 28_04_24.Noobs
4. 28_04_23.Noobs
5. 26_06_23.Noobs
6. 26_05_23.Noobs
7. 26_04_23.Noobs
8. 23_04_23.Noobs
9. 23_03_23.Noobs
10. 21_06_23.Noobs
11. 21_05_23.Noobs
12. 21_04_23.Noobs
13. 20_03_23.Noobs
14. 17_04_23.Noobs
15. 16_06_23.Noobs
16. 16_05_23.Noobs
17. 11_07_23.Noobs
18. 11_06_23.Noobs
19. 11_05_23.Noobs
20. 06_07_23.Noobs
21. 06_06_23.Noobs
22. 06_05_23.Noobs
23. 04_05_23.Noobs
24. 01_07_23.Noobs
25. 01_06_23.Noobs
26. 01_05_23.Noobs
Enter the number of the dump you want to download: 3
Downloading 28_04_24.Noobs.xml...
Importing XML dump into MediaWiki...
Done!
You might want to run rebuildrecentchanges.php to regenerate RecentChanges,
and initSiteStats.php to update page and revision counts

Import completed successfully.

</pre>

== Post-Setup Maintenance ==

Now, we need to rebuild our wiki so that the database reflects our imported content.

=== Login to Container for Maintenance ===
* Syntax:<code>docker exec -it <directory_name>-<service>-1 /bin/bash</code>
** use:<code>docker container ls</code> to see container and service names.
<source lang="bash">
docker exec -it noobwiki-mediawiki-1 /bin/bash
</source>

* Run maintenance scripts:
<source lang="bash">
php maintenance/initSiteStats.php
php maintenance/rebuildrecentchanges.php
php maintenance/rebuildall.php
</source>

* Exit the container:
<source lang="bash">
exit
</source>

=== Verify Wiki Content ===
* Check all pages have loaded by visiting:
<source lang="bash">
http://127.0.0.1:8080/index.php/Special:AllPages
</source>

Here's the section in raw MediaWiki syntax:

== Network Configuration ==

By default, your wiki might only be accessible from the host machine where Docker is running, using <code>localhost</code> or <code>127.0.0.1</code>. However, if you want others on your network to access your wiki, you need to make some adjustments.

'''Current Setup:''' The computer running Docker Compose has an IP address of <code>192.168.0.44</code>.

* You can find the IP address of your computer running Docker using the command:
<code>ip addr</code><br>
<div class="toccolours mw-collapsible mw-collapsed">
OutPut from <code>ip addr</code>
<div class="mw-collapsible-content">
<pre>
noob@noob-HP-EliteDesk-800-G1-DM:~$ ip addr
1: lo: <LOOPBACK,UP,LOWER_UP> mtu 65536 qdisc noqueue state UNKNOWN group default qlen 1000
link/loopback 00:00:00:00:00:00 brd 00:00:00:00:00:00
inet 127.0.0.1/8 scope host lo
valid_lft forever preferred_lft forever
inet6 ::1/128 scope host noprefixroute
valid_lft forever preferred_lft forever
2: eno1: <NO-CARRIER,BROADCAST,MULTICAST,UP> mtu 1500 qdisc fq_codel state DOWN group default qlen 1000
link/ether 8c:dc:d4:3d:93:49 brd ff:ff:ff:ff:ff:ff
altname enp0s25
3: wlxe8de27142be2: <BROADCAST,MULTICAST,UP,LOWER_UP> mtu 1500 qdisc noqueue state UP group default qlen 1000
link/ether e8:de:27:14:2b:e2 brd ff:ff:ff:ff:ff:ff
inet 192.168.0.44/24 brd 192.168.0.255 scope global dynamic noprefixroute wlxe8de27142be2
valid_lft 86357sec preferred_lft 86357sec
inet6 fe80::afbe:cc73:73a2:fcdf/64 scope link noprefixroute
valid_lft forever preferred_lft forever
</pre>
</div>
</div>

My IP is <code>192.168.0.44</code>

If someone from another computer on the network tries to visit <code>192.168.0.44:8080</code>, they might encounter a "cannot connect" error. This happens because MediaWiki, by default, redirects to <code>127.0.0.1:8080</code>, which is only accessible from the host machine itself.

'''Solution:''' To allow access from other devices on the same network, you need to:

* '''Edit the <code>LocalSettings.php</code> File:''' This isn't done inside the Docker container but rather in the directory where your <code>docker-compose.yml</code> file is located. Here, you need to change the server URL configuration.

* '''Modify URL Configuration:''' On lines 34-35 of <code>LocalSettings.php</code>, you'll find the following:

=== Allowing Access from Other Network Devices ===
* Edit <code>LocalSettings.php</code> in the Docker Compose directory to change the server URL:

<source lang="php">
## The protocol and server name to use in fully-qualified URLs
$wgServer = 'http://192.168.0.44:8080';
</source>

* Restart Docker to apply changes:

<source lang="bash">
docker-compose restart
</source>

This allows access to your wiki from other devices on the network using <code>192.168.0.44:8080</code>.
This adjustment tells MediaWiki to use the network IP of the host (<code>192.168.0.44</code>) instead of the local loopback (<code>127.0.0.1</code>), allowing other devices on the network to access the wiki through <code>192.168.0.44:8080</code>. Even after this change, <code>localhost:8080</code> or <code>127.0.0.1:8080</code> will still work on the host machine, but now the wiki is also accessible via the network IP from other devices.

CompleteNoobs Local Wiki In Docker - Revision history

AwesomO: /* Starting Environment */

AwesomO: /* Script Details */

AwesomO: /* Login to Container for Maintenance */

AwesomO at 20:32, 19 February 2025

AwesomO: /* Configure User Permissions */