CompleteNoobs - User contributions [en]

Delegate Hive Power (HP) to Another Account

2026-04-27T11:02:17Z

AwesomO: Created page with "= Delegate Hive Power (HP) to Another Account = '''CompleteNoobs Walkthrough''' ''How to lend your Hive Power (HP) to another account safely and easily'' == What is HP Delegation? == Hive Power (HP) is your staked HIVE. When you '''delegate''' HP to another account, you are temporarily lending them your voting power and Resource Credits (RC). - You still '''own''' the HP 100%. - The other person can use the voting power to upvote posts. - You can take it back when..."

= Delegate Hive Power (HP) to Another Account =

'''CompleteNoobs Walkthrough'''
''How to lend your Hive Power (HP) to another account safely and easily''

== What is HP Delegation? ==
Hive Power (HP) is your staked HIVE. When you '''delegate''' HP to another account, you are temporarily lending them your voting power and Resource Credits (RC).

- You still '''own''' the HP 100%.
- The other person can use the voting power to upvote posts.
- You can take it back whenever you want (undelegate).
- This is very common on Hive to support projects, friends, curators, or to rent voting power.

== Why Would You Do This? ==
- Help a friend or project get more voting power
- Support a curation team or witness
- Earn a small fee by renting your HP (some people do this)
- Move voting power between your own accounts

== Important Warnings (Read This First) ==
'''⚠️ Only delegate what you are comfortable lending.'''
'''⚠️ Never share your private keys or posting key.'''
'''⚠️ Always double-check the "To" account name before confirming.'''
'''⚠️ Start with a small test amount (e.g. 10 HP) the first time.'''
'''⚠️ Use trusted interfaces only (PeakD or Hive Keychain recommended).'''

== Prerequisites ==
- A Hive account with some Hive Power (HP)
- Either:
- Hive Keychain browser extension (recommended), '''or'''
- Access to PeakD.com

== Method 1: Easiest – Using PeakD.com (Web Interface) ==

=== Step 1: Go to PeakD ===
# Open your browser and go to: [https://peakd.com/ https://peakd.com/]
# Click '''Login''' (top right) and log in with '''Hive Keychain''' (easiest) or your posting/active key.

=== Step 2: Open Your Wallet ===
# Click on your username (top right) → '''Wallet'''

=== Step 3: Start the Delegation ===
# In the wallet, look for the big blue button that says '''Delegate HP''' (or "Power Delegation").
# If you don't see it immediately, scroll down to the '''"Delegations"''' section and click '''Delegate'''.

=== Step 4: Fill in the Details ===
# In the popup/window that appears:
#* '''To:''' → Type the exact Hive username you want to delegate to (e.g. <code>@completenoobs</code>)
#* '''Amount:''' → Enter how much HP you want to delegate (you can use decimals, e.g. <code>50.123</code>)
#* (Optional) Add a memo if you want

=== Step 5: Confirm and Send ===
# Review everything carefully.
# Click '''Delegate''' or '''Confirm'''.
# Approve the transaction in Hive Keychain (or enter your active key if using manual login).
# You should see a green success message.

'''Done!''' The HP is now delegated.

== Method 2: Fastest – Using Hive Keychain Extension (Recommended) ==

This is the quickest way once you have the extension installed.

=== Step 1: Install Hive Keychain (if you haven't) ===
# Go to the Chrome Web Store (or Firefox Add-ons) and search for '''"Hive Keychain"'''.
# Install it and set it up with your Hive account.

=== Step 2: Open Keychain ===
# Click the little Hive Keychain icon in your browser toolbar.
# Make sure you are logged into the account that has the HP.

=== Step 3: Choose Delegate ===
# In the Keychain popup, click the '''Delegate''' button (it usually has a little arrow icon).

=== Step 4: Enter Details ===
# Fill in:
#* '''Delegate to:''' → The username (without the @)
#* '''Amount:''' → How much HP to send
# Click '''Next''' → Review → '''Confirm'''

'''Done!''' Super fast.

== How to Check Your Current Delegations ==

=== On PeakD ===
# Go to your Wallet → scroll down to the '''Delegations''' tab.
# You will see two sections:
#* '''Outgoing''' (what you have delegated to others)
#* '''Incoming''' (what others have delegated to you)

=== On Hive Keychain ===
# Click the Keychain icon → '''Delegations''' tab.

== How to Undelegate (Take Your HP Back) ==

The process is almost identical to delegating:

1. Go back to PeakD Wallet or Hive Keychain.
2. Find the delegation you want to cancel.
3. Click '''Undelegate''' (or set the amount to 0).
4. Confirm the transaction.

'''Note:''' On Hive, undelegation usually returns the power within a few minutes to a few hours (much faster than the old Steem 5-day cooldown).

== Advanced: Using the Command Line (CLI) ==

Only do this if you are comfortable with the terminal.

Using <code>beem</code> Python library (example):

<pre>
beempy delegate @youraccount @targetaccount 100 HP
</pre>

Or using the official hived CLI (more advanced).
== Common Questions ==
* '''Q: Can I delegate all my HP?'''
A: Yes, but leave a little for yourself so you can still make transactions (you need some RC).
* '''Q: Do I still earn rewards on delegated HP?'''
A: Yes — you still own the HP and continue to receive the 10% annual inflation reward on it. Only the '''voting power''' is lent.
* '''Q: Is there a fee?'''
A: No delegation fee on Hive (only tiny blockchain resource cost).
*'''Q: Can the person I delegate to steal my HP?'''
A: No. They can only use the voting power. You always keep ownership.

Main Page

2026-04-27T01:31:37Z

AwesomO: /* In Concept development Mode - a wiki you can download */

=In Concept development Mode - a wiki you can download=

* [https://www.completenoobs.com/noobs/V4call-v0.11| cnoobs.com on hold while working on v4call]
* https://github.com/CompleteNoobs/v4call

= CompleteNoobs: A Downloadable Wiki for Reproducible Computer Tutorials =

'''CompleteNoobs''' is a open-source wiki offering free, reproducible computer science tutorials.

* [[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.]]

== About CompleteNoobs ==

Our mission is to provide accessible, libre-licensed resources for hobbyists, sysadmins, students, teachers, and computer science enthusiasts. All content is available under a '''Creative Commons BY-NC-SA''' license, ensuring the freedoms to:
* Read
* Edit/Modify
* Copy
* Share freely

Download the wiki as an XML file at [https://xml.completenoobs.com xml.completenoobs.com] or access data-heavy content (images, videos, audio) via '''IPFS''' hashes.

== Get Started ==

* '''Download the Wiki''': Run CompleteNoobs locally using our [[Local_CompleteNoobs_Wiki|Manually install guides or Docker image]].
* '''Host Your Own''': Set up your own MediaWiki instance with our guide: [[Host_Your_Own_Mediawiki_Online|Host Your Own MediaWiki Online]].

== CompleteNoobs Blockchain Project ==

As Noobs we want to learn more about bitcoin, without losing any real bitcoin

First we are learning how to fork bitcoin version 0.14.3, best way to learn is by tinkering with it.
* [[N33Bcoin| n33b.com]]

== Essential Links ==

* [[Main_Index|Main Index Page]]
* [[Special:AllPages|All Pages]]
* [[Wiki_Basic_Syntax|Wiki Basic Syntax]]
* [[COMPLETENOOBS_FUNDING|Support Us]]

== Licenses ==
[[LICENCE_HEADERS]]
All content is libre-licensed for free copying, modification, and distribution. Add a license header to your contributions using:
<pre>{{:LICENCE_HEADER_CC0}}</pre>
{{:LICENCE_HEADER_CC0}}

== Disclaimer ==

<div class="toccolours mw-collapsible mw-collapsed">
'''''DISCLAIMER:'''''
<div class="mw-collapsible-content">
Content on CompleteNoobs is for informational and educational purposes only. We make no warranties about accuracy or reliability. Use at your own risk. Links to external sites are not endorsements, and we are not responsible for their content or availability. The site may be temporarily unavailable due to technical issues beyond our control.
</div>
</div>

{{Special:ContributionScores/10/5}}
{{Special:PopularPages/10}}

Main Page

2026-04-27T01:11:48Z

AwesomO: /* In Concept development Mode - a wiki you can download */

=In Concept development Mode - a wiki you can download=

* [https://www.completenoobs.com/noobs/V4call-v0.11| cnoobs.com on hold while working on v4call]

= CompleteNoobs: A Downloadable Wiki for Reproducible Computer Tutorials =

'''CompleteNoobs''' is a open-source wiki offering free, reproducible computer science tutorials.

* [[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.]]

== About CompleteNoobs ==

Our mission is to provide accessible, libre-licensed resources for hobbyists, sysadmins, students, teachers, and computer science enthusiasts. All content is available under a '''Creative Commons BY-NC-SA''' license, ensuring the freedoms to:
* Read
* Edit/Modify
* Copy
* Share freely

Download the wiki as an XML file at [https://xml.completenoobs.com xml.completenoobs.com] or access data-heavy content (images, videos, audio) via '''IPFS''' hashes.

== Get Started ==

* '''Download the Wiki''': Run CompleteNoobs locally using our [[Local_CompleteNoobs_Wiki|Manually install guides or Docker image]].
* '''Host Your Own''': Set up your own MediaWiki instance with our guide: [[Host_Your_Own_Mediawiki_Online|Host Your Own MediaWiki Online]].

== CompleteNoobs Blockchain Project ==

As Noobs we want to learn more about bitcoin, without losing any real bitcoin

First we are learning how to fork bitcoin version 0.14.3, best way to learn is by tinkering with it.
* [[N33Bcoin| n33b.com]]

== Essential Links ==

* [[Main_Index|Main Index Page]]
* [[Special:AllPages|All Pages]]
* [[Wiki_Basic_Syntax|Wiki Basic Syntax]]
* [[COMPLETENOOBS_FUNDING|Support Us]]

== Licenses ==
[[LICENCE_HEADERS]]
All content is libre-licensed for free copying, modification, and distribution. Add a license header to your contributions using:
<pre>{{:LICENCE_HEADER_CC0}}</pre>
{{:LICENCE_HEADER_CC0}}

== Disclaimer ==

<div class="toccolours mw-collapsible mw-collapsed">
'''''DISCLAIMER:'''''
<div class="mw-collapsible-content">
Content on CompleteNoobs is for informational and educational purposes only. We make no warranties about accuracy or reliability. Use at your own risk. Links to external sites are not endorsements, and we are not responsible for their content or availability. The site may be temporarily unavailable due to technical issues beyond our control.
</div>
</div>

{{Special:ContributionScores/10/5}}
{{Special:PopularPages/10}}

HTML Expanding info box

2026-04-27T01:08:48Z

AwesomO: /* Full Example Page */

== How to Add an Expanding Info Box (Simple Guide)==

{| class="wikitable"
|-
! Feature
! Value
|-
| Method
| <details> + <summary>
|-
| JavaScript
| Not needed
|-
| Mobile Support
| Yes
|-
| Difficulty
| Very Easy
|}

=== Basic Example===

<pre>
<details>
<summary>What you will like</summary>

<div>
<p>This content is hidden until clicked.</p>
<code>print "hello content"</code>
</div>

</details>
</pre>

=== Optional CSS Styling===

<pre>
body {
font-family: sans-serif;
}

details {
border: 1px solid #aaa;
margin: 20px 0;
padding: 5px;
}

summary {
font-weight: bold;
cursor: pointer;
}
</pre>

=== Dark Mode (Optional)===

<pre>
@media (prefers-color-scheme: dark) {
details {
background: #222;
color: #ddd;
border: 1px solid #555;
}

summary {
color: #fff;
}
}
</pre>

=== Full Example Page===

<pre>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Example</title>

<style>
body {
font-family: sans-serif;
max-width: 800px;
margin: 40px auto;
padding: 20px;
}

details {
border: 1px solid #aaa;
margin: 20px 0;
padding: 5px;
background: #f9f9f9;
}

summary {
font-weight: bold;
cursor: pointer;
}

/* Dark Mode */
@media (prefers-color-scheme: dark) {
body {
background: #111;
color: #ddd;
}

details {
background: #222;
border: 1px solid #555;
}

summary {
color: #fff;
}
}
</style>
</head>

<body>

<h1>Example Page</h1>

<details>
<summary>What you will like</summary>
<div>
<p>Hidden content here...</p>
<code>print "hello content"</code>
</div>
</details>

</body>
</html>
</pre>


<div class="toccolours mw-collapsible mw-collapsed">
Another example:
<div class="mw-collapsible-content">

<pre>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>completenoobs.com</title>
<style>
body { font-family: system-ui, -apple-system, sans-serif; max-width: 800px; margin: 40px auto; padding: 20px; line-height: 1.6; }

details {
border: 1px solid #ddd;
border-radius: 8px;
margin: 25px 0;
background: #f9f9f9;
}
summary {
padding: 15px 20px;
font-weight: bold;
cursor: pointer;
background: #f0f0f0;
border-radius: 8px 8px 0 0;
}
.mw-collapsible-content { padding: 20px; }

/* Dark Mode */
@media (prefers-color-scheme: dark) {
details { border: 1px solid #555; background: #1e1e1e; color: #ddd; }
summary { background: #2a2a2a; color: #eee; }
.mw-collapsible-content { color: #ccc; }
}
</style>
</head>
<body>

<h1>Welcome to completenoobs.com</h1>

<details>
<summary>What you will like</summary>
<div class="mw-collapsible-content">
<p>Put all your hidden content here...</p>
<code>print "hello content"</code>
</div>
</details>

</body>
</html>

</pre>

</div>
</div>

=== Tips===

* To open by default: <code><details open></code>
* Duplicate the block to create more sections
* Works without CSS (just looks basic)

<div class="toccolours mw-collapsible mw-collapsed">
The CSS explained:
<div class="mw-collapsible-content">

'''What is CSS?'''

CSS is what makes things look nice.

* HTML = the structure (the box)
* CSS = the style (colors, spacing, fonts)

----

'''The Page (body)'''
<pre>
body {
font-family: sans-serif;
max-width: 800px;
margin: 40px auto;
padding: 20px;
}
</pre>

This controls the whole page:

* Changes the font
* Keeps the page centered
* Adds space so things are easy to read

----

'''The Box (details)'''
<pre>
details {
border: 1px solid #aaa;
margin: 20px 0;
padding: 5px;
background: #f9f9f9;
}
</pre>

This is the expandable box:

* Border = thin line around it
* Margin = space outside the box
* Padding = space inside the box
* Background = box color

----

'''The Clickable Title (summary)'''
<pre>
summary {
font-weight: bold;
cursor: pointer;
}
</pre>

This is what you click:

* Bold text
* Mouse turns into a hand

----

'''Dark Mode (automatic)'''
<pre>
@media (prefers-color-scheme: dark) {
</pre>

This means:

"If the user is using dark mode, use different colors"

----

'''Dark Mode Colours'''
<pre>
body {
background: #111;
color: #ddd;
}

details {
background: #222;
border: 1px solid #555;
}

summary {
color: #fff;
}
</pre>

This makes:

* Dark background
* Light text
* Darker boxes

----

'''How to Change Colours'''

* Darker background → change <code>#111</code>
* Lighter text → change <code>#ddd</code>
* Box color → change <code>#222</code>

Examples:

* <code>#000</code> = pure black
* <code>#fff</code> = pure white
* <code>#1a1a1a</code> = softer black

----

'''Force Dark Mode (always on)'''

Remove the <code>@media</code> line and just use:

<pre>
body {
background: #111;
color: #ddd;
}
</pre>

----

'''Super Simple Summary'''

* CSS = makes things look nice
* details = the box
* summary = the clickable title
* dark mode = automatic color switch

</div>
</div>

HTML Expanding info box

2026-04-27T01:02:11Z

AwesomO: Created page with "== How to Add an Expanding Info Box (Simple Guide)== {| class="wikitable" |- ! Feature ! Value |- | Method | <details> + <summary> |- | JavaScript | Not needed |- | Mobile Support | Yes |- | Difficulty | Very Easy |} === Basic Example=== <pre> <details> <summary>What you will like</summary> <div> <p>This content is hidden until clicked.</p> <code>print "hello content"</code> </div> </details> </pre> === Optional CSS Styling=== <pre> body {..."

== How to Add an Expanding Info Box (Simple Guide)==

{| class="wikitable"
|-
! Feature
! Value
|-
| Method
| <details> + <summary>
|-
| JavaScript
| Not needed
|-
| Mobile Support
| Yes
|-
| Difficulty
| Very Easy
|}

=== Basic Example===

<pre>
<details>
<summary>What you will like</summary>

<div>
<p>This content is hidden until clicked.</p>
<code>print "hello content"</code>
</div>

</details>
</pre>

=== Optional CSS Styling===

<pre>
body {
font-family: sans-serif;
}

details {
border: 1px solid #aaa;
margin: 20px 0;
padding: 5px;
}

summary {
font-weight: bold;
cursor: pointer;
}
</pre>

=== Dark Mode (Optional)===

<pre>
@media (prefers-color-scheme: dark) {
details {
background: #222;
color: #ddd;
border: 1px solid #555;
}

summary {
color: #fff;
}
}
</pre>

=== Full Example Page===

<pre>
<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title>Example</title>

<style>
body {
font-family: sans-serif;
max-width: 800px;
margin: 40px auto;
padding: 20px;
}

details {
border: 1px solid #aaa;
margin: 20px 0;
padding: 5px;
background: #f9f9f9;
}

summary {
font-weight: bold;
cursor: pointer;
}

/* Dark Mode */
@media (prefers-color-scheme: dark) {
body {
background: #111;
color: #ddd;
}

details {
background: #222;
border: 1px solid #555;
}

summary {
color: #fff;
}
}
</style>
</head>

<body>

<h1>Example Page</h1>

<details>
<summary>What you will like</summary>
<div>
<p>Hidden content here...</p>
<code>print "hello content"</code>
</div>
</details>

</body>
</html>
</pre>
</pre>

=== Tips===

* To open by default: <code><details open></code>
* Duplicate the block to create more sections
* Works without CSS (just looks basic)

<div class="toccolours mw-collapsible mw-collapsed">
The CSS explained:
<div class="mw-collapsible-content">

'''What is CSS?'''

CSS is what makes things look nice.

* HTML = the structure (the box)
* CSS = the style (colors, spacing, fonts)

----

'''The Page (body)'''
<pre>
body {
font-family: sans-serif;
max-width: 800px;
margin: 40px auto;
padding: 20px;
}
</pre>

This controls the whole page:

* Changes the font
* Keeps the page centered
* Adds space so things are easy to read

----

'''The Box (details)'''
<pre>
details {
border: 1px solid #aaa;
margin: 20px 0;
padding: 5px;
background: #f9f9f9;
}
</pre>

This is the expandable box:

* Border = thin line around it
* Margin = space outside the box
* Padding = space inside the box
* Background = box color

----

'''The Clickable Title (summary)'''
<pre>
summary {
font-weight: bold;
cursor: pointer;
}
</pre>

This is what you click:

* Bold text
* Mouse turns into a hand

----

'''Dark Mode (automatic)'''
<pre>
@media (prefers-color-scheme: dark) {
</pre>

This means:

"If the user is using dark mode, use different colors"

----

'''Dark Mode Colours'''
<pre>
body {
background: #111;
color: #ddd;
}

details {
background: #222;
border: 1px solid #555;
}

summary {
color: #fff;
}
</pre>

This makes:

* Dark background
* Light text
* Darker boxes

----

'''How to Change Colours'''

* Darker background → change <code>#111</code>
* Lighter text → change <code>#ddd</code>
* Box color → change <code>#222</code>

Examples:

* <code>#000</code> = pure black
* <code>#fff</code> = pure white
* <code>#1a1a1a</code> = softer black

----

'''Force Dark Mode (always on)'''

Remove the <code>@media</code> line and just use:

<pre>
body {
background: #111;
color: #ddd;
}
</pre>

----

'''Super Simple Summary'''

* CSS = makes things look nice
* details = the box
* summary = the clickable title
* dark mode = automatic color switch

</div>
</div>

V4call-v0.11

2026-04-25T01:49:08Z

AwesomO: Created page with "{{:LICENCE_HEADER_MIT}} = v4call — Deploy Your Own Server on Ubuntu 24.04 with Docker = From CompleteNoobs This guide walks through deploying your own v4call server from scratch on a fresh Vultr Ubuntu 24.04 VPS — from first login to a working HTTPS video/audio calling service on your own domain, optionally federated with other v4call servers. v4call is an open-source, decentralised video and audio calling platform that uses Hive blockchain for identity and HBD..."

{{:LICENCE_HEADER_MIT}}

= v4call — Deploy Your Own Server on Ubuntu 24.04 with Docker =

From CompleteNoobs

This guide walks through deploying your own v4call server from scratch on a fresh Vultr Ubuntu 24.04 VPS — from first login to a working HTTPS video/audio calling service on your own domain, optionally federated with other v4call servers.

v4call is an open-source, decentralised video and audio calling platform that uses Hive blockchain for identity and HBD micropayments. It supports custom Hive-Engine token payments, encrypted direct messages with persistent chat history, voice-only and video calls, and a free-market platform fee system. Fork it, run your own server, keep all your platform fees, join the federation.

'''Source code''': [https://github.com/CompleteNoobs/v4call https://github.com/CompleteNoobs/v4call]

'''End result''': A working v4call server at <code>https://call.yourdomain.com</code> that you can log into with a Hive account, optionally connected to other v4call servers via federation.

== Contents ==

* [[#What_You_Need|1 What You Need]]
* [[#Step_1:_Create_Your_Vultr_VPS|2 Step 1: Create Your Vultr VPS]]
* [[#Step_2:_Point_Your_Domain_at_the_VPS|3 Step 2: Point Your Domain at the VPS]]
* [[#Step_3:_Log_into_Your_VPS|4 Step 3: Log into Your VPS]]
* [[#Step_4:_Update_the_Server|5 Step 4: Update the Server]]
* [[#Step_5:_Install_Docker|6 Step 5: Install Docker]]
* [[#Step_6:_Install_Git|7 Step 6: Install Git]]
* [[#Step_7:_Fork_and_Clone_the_Code|8 Step 7: Fork and Clone the Code]]
* [[#Step_8:_Configure_Your_Server_(.env_file)|9 Step 8: Configure Your Server (.env file)]]
* [[#Step_9:_Configure_Nginx_—_HTTP_Only_First|10 Step 9: Configure Nginx — HTTP Only First]]
* [[#Step_10:_Create_Data_Directories_and_Fix_Permissions|11 Step 10: Create Data Directories and Fix Permissions]]
* [[#Step_11:_Build_and_Start_the_Server|12 Step 11: Build and Start the Server]]
* [[#Step_12:_Get_Your_SSL_Certificate|13 Step 12: Get Your SSL Certificate]]
* [[#Step_13:_Enable_HTTPS_in_Nginx|14 Step 13: Enable HTTPS in Nginx]]
* [[#Step_14:_Set_Up_SSL_Auto-Renewal|15 Step 14: Set Up SSL Auto-Renewal]]
* [[#Step_15:_Test_Everything_is_Working|16 Step 15: Test Everything is Working]]
* [[#Step_16:_Set_Up_Your_Call_Rates_on_Hive|17 Step 16: Set Up Your Call Rates on Hive]]
* [[#Step_17:_Federation_Setup_(Optional)|18 Step 17: Federation Setup (Optional)]]
* [[#Feature_Guide:_What_Your_Server_Can_Do|19 Feature Guide: What Your Server Can Do]]
* [[#Admin_Configuration_Reference|20 Admin Configuration Reference]]
* [[#Updating_Your_Server|21 Updating Your Server]]
* [[#Common_Problems_and_Fixes|22 Common Problems and Fixes]]
* [[#Quick_Reference|23 Quick Reference]]

== What You Need ==

Before starting, make sure you have the following:

* '''A Vultr account''' — sign up at [https://vultr.com vultr.com] - please use are [https://www.vultr.com/?ref=7704739 Vultr Referral link] to help us cover server costs.
* '''A domain name''' with DNS access — e.g. <code>call.yourdomain.com</code>
* '''Two Hive accounts''' — one for your server identity (receives platform fees), one for escrow (holds caller funds during calls). Create free accounts at [https://signup.hive.io signup.hive.io]
* '''Hive Keychain browser extension''' — for login and payments. Install from [https://hive-keychain.com hive-keychain.com]
* '''A GitHub account''' — free at [https://github.com github.com]. You will fork the v4call project.
* '''A terminal''' — Mac: Terminal app. Windows: PowerShell or PuTTY.

You do not need to know how to code. Every command can be copy-pasted exactly as shown.

== Step 1: Create Your Vultr VPS ==

# Log into [https://my.vultr.com my.vultr.com]
# Click '''Deploy New Server'''
# Choose '''Cloud Compute — Shared CPU'''
# Choose a location close to you
# Choose '''Ubuntu 24.04 LTS x64'''
# Choose the '''$6/month''' plan (1 CPU, 1GB RAM)
# Set Server Hostname to something like <code>v4call-server</code>
# Click '''Deploy Now'''

Wait ~60 seconds for it to start. Click the server to find:
* '''IP Address''' — looks like <code>123.456.789.012</code> — write it down
* '''Password''' — click the eye icon — write it down

== Step 2: Point Your Domain at the VPS ==

Log into your DNS provider and add an A record:

{| class="wikitable"
|-
! Field !! Value
|-
| Type || A
|-
| Name || <code>call</code> (or <code>@</code> for root domain)
|-
| Value || Your VPS IP address
|-
| TTL || 300
|}

DNS takes a few minutes to propagate. Check from your computer later:

nslookup call.yourdomain.com

Must show your VPS IP before Step 12. You can continue with all other steps while waiting.

== Step 3: Log into Your VPS ==

Open a terminal on your computer:

ssh root@YOUR_SERVER_IP
* NOTE: you can also do <code>root@your-domain.com</code>

Type <code>yes</code> when asked about the fingerprint, then paste the password from Vultr (right-click to paste in most terminals).

When you see <code>root@v4call-server:~#</code> you are in.

== Step 4: Update the Server ==

apt update && apt upgrade -y

Wait for it to complete (1-2 minutes).

== Step 5: Install Docker ==

Install Docker using the official installer script:

curl -fsSL https://get.docker.com | sh

Verify:

docker --version

Should show <code>Docker version 26.x.x</code> or similar.

Install Docker Compose plugin:

apt install -y docker-compose-plugin

Verify:

docker compose version

Should show <code>Docker Compose version v2.x.x</code>.

== Step 6: Install Git ==

apt install -y git
git --version

== Step 7: Fork and Clone the Code ==

=== Clone onto your VPS ===

cd /opt
git clone https://github.com/CompleteNoobs/v4call.git
cd v4call

==== Fork on GitHub - Optional ====

Forking gives you your own copy of the code that you can customise — change the name, branding, fees — without affecting the original project.

# Go to [https://github.com/CompleteNoobs/v4call https://github.com/CompleteNoobs/v4call]
# Click the '''Fork''' button (top right of the page)
# Select your GitHub account as the destination
# Click '''Create fork'''

You now have your own copy at <code>https://github.com/YOURUSERNAME/v4call</code>

==== Clone onto your VPS ====

cd /opt
git clone https://github.com/YOURUSERNAME/v4call.git
cd v4call

List the files to confirm:

ls

You should see: <code>server.js public/ Dockerfile docker-compose.yml nginx/ package.json .env.example README.md</code>

'''Worth knowing about the <code>public/</code> folder''' — alongside the main UI (<code>index.html</code>) you'll find:

* <code>rate-editor.html</code> — generates your rates post for Hive
* <code>server-sign.html</code> — generates the signed federation verify file (used in [[#Step_17:_Federation_Setup_(Optional)|Federation Setup]] below)
* <code>server-announce.html</code> — publishes your server to the on-chain federation directory
* <code>admin-peers.html</code> — manages your federation peer list
* <code>info.html</code> — public landing page for visitors who haven't logged in
* <code>.well-known/v4call-server.json</code> — placeholder; each operator overwrites this with their own signed file in [[#Step_17:_Federation_Setup_(Optional)|Federation Setup]]

== Step 8: Configure Your Server (.env file) ==

All settings live in a single <code>.env</code> file. Copy the template:

cp .env.example .env
nano .env

Fill in your values:

<pre>
# ── Server Identity ──────────────────────────────────────
SERVER_NAME=yourcallapp
SERVER_DOMAIN=call.yourdomain.com
SERVER_HIVE_ACCOUNT=yourhiveaccount
ESCROW_ACCOUNT=yourescrowaccount
V4CALL_ESCROW_KEY=5Kxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# Secret key to access /admin/* endpoints.
# Choose a long random string — treat it like a password.
# Example: openssl rand -hex 32
ADMIN_KEY=make-up-a-long-random-string-at-least-20-characters

# ── Hive Blockchain ──────────────────────────────────────
CHAIN=hive
HIVE_API=

# ── Platform Fee ─────────────────────────────────────────
# Percentage your server takes from each paid call/DM (10 = 10%)
# This is the MINIMUM fee — users whose rates post sets a lower
# platform fee will be rejected. Users who set a higher fee
# get the best price (your server's rate, not their higher number).
DEFAULT_PLATFORM_FEE=10

# ── Network ──────────────────────────────────────────────
PORT=3000
BIND_HOST=127.0.0.1

# ── Chat Storage ─────────────────────────────────────────
# How many days to keep stored DMs before automatic cleanup
DM_RETENTION_DAYS=33
# How many days to keep stored room messages before cleanup
ROOM_RETENTION_DAYS=33
# How many recent DMs per conversation to show on login (0 = off)
DM_PREVIEW_COUNT=1

# ── Call Behaviour (advanced — defaults are fine) ────────
# CALL_COOLDOWN_MS=30000
# MAX_CALL_DURATION_MIN=120
# PAYMENT_VERIFY_RETRIES=3
# PAYMENT_VERIFY_DELAY_MS=5000

# ── Federation (optional) ────────────────────────────────
# Comma-separated list of peer v4call server federation WebSocket URLs.
# Leave blank for standalone mode (no federation).
# Servers listed here are auto-approved on startup. Discovered peers
# (via Hive directory) need manual approval at /admin-peers.html.
# Example two-server setup:
# On call.completenoobs.com → FEDERATION_PEERS=wss://hive-book.com/federation
# On hive-book.com → FEDERATION_PEERS=wss://call.completenoobs.com/federation
FEDERATION_PEERS=
</pre>

Key points:

* <code>V4CALL_ESCROW_KEY</code> — must be the '''active''' private key for your escrow account. Find it in your Hive wallet → Keys & Permissions → Active. Starts with <code>5K</code>. '''Never share this.'''
* <code>ADMIN_KEY</code> — invent a secret password for accessing admin tools
* <code>HIVE_API</code> — leave blank to use all built-in Hive nodes automatically
* <code>DEFAULT_PLATFORM_FEE</code> — your server's minimum platform fee percentage. See [[#Platform_Fee_System|Platform Fee System]] below for how this works.
* <code>DM_RETENTION_DAYS</code> / <code>ROOM_RETENTION_DAYS</code> — how long chat messages are kept in the database. A cleanup job runs every hour and deletes anything older. Set to <code>0</code> to keep messages indefinitely (not recommended).
* <code>DM_PREVIEW_COUNT</code> — when a user logs in, this many recent DMs per conversation are loaded into the lobby chat so they can see previews. Set to <code>0</code> to disable previews (users still get an unread count alert).
* <code>FEDERATION_PEERS</code> — leave blank for now. You can add peers later (see [[#Step_17:_Federation_Setup_(Optional)|Federation Setup]]).

Save: '''Ctrl+X''' → '''Y''' → '''Enter'''

== Step 9: Configure Nginx — HTTP Only First ==

'''This step is critical.''' A very common mistake is putting the HTTPS/SSL config in Nginx before getting the certificate. Nginx tries to load the certificate at startup — if the file doesn't exist yet, Nginx crashes in a restart loop. Certbot then cannot serve the challenge because Nginx is down. Result: no certificate, stuck in a loop.

The fix: always start with HTTP only, get the certificate, then add HTTPS.

Edit the Nginx config:

nano /opt/v4call/nginx/v4call.conf

Delete everything and replace with this HTTP-only config:

<pre>
server {
listen 80;
server_name call.yourdomain.com www.call.yourdomain.com;

# Certbot challenge path — do not remove this block
location /.well-known/acme-challenge/ {
root /var/www/certbot;
}

# Proxy all other requests to the v4call app
location / {
proxy_pass http://app:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_read_timeout 86400;
}
}
</pre>

Replace <code>call.yourdomain.com</code> with your actual domain in both places.

Save: '''Ctrl+X''' → '''Y''' → '''Enter'''

== Step 10: Create Data Directories and Fix Permissions ==

Create the folders Docker uses for persistent data:

mkdir -p /opt/v4call/data/logs \
mkdir -p /opt/v4call/data/certbot/conf \
mkdir -p /opt/v4call/data/certbot/www/.well-known/acme-challenge \
mkdir -p /opt/v4call/data/certbot/logs

'''Fix permissions — do not skip this.'''

The v4call app runs inside Docker as user <code>node</code> (UID 1000). On the host, these directories are created by root, so the container cannot write to them. This causes a <code>SQLITE_CANTOPEN</code> error that crashes the app.

Fix the logs directory for the app:

chown -R 1000:1000 /opt/v4call/data/logs

Certbot runs as root so its directories stay root-owned:

chown -R root:root /opt/v4call/data/certbot
chmod -R 755 /opt/v4call/data/certbot

'''Note:''' The app creates two separate SQLite databases in the logs directory:
* <code>v4call-ledger.db</code> — payment records (calls, ring fees, payouts). Only the server writes to this.
* <code>v4call-chat.db</code> — stored DMs and room messages. Separate from the ledger for security — if a bug in chat storage were exploited, the payment ledger remains untouched.

Federation also persists state in this directory:
* <code>approved-peers.json</code> — list of federation peer domains you've approved (created on first approval; survives container restarts).

== Step 11: Build and Start the Server ==

cd /opt/v4call
docker compose up -d --build

The first build downloads dependencies and takes 2-4 minutes. Check the status:

docker compose ps

You should see:

<pre>
NAME STATUS
v4call-app Up (healthy)
v4call-nginx Up
</pre>

Check the app started correctly:

docker compose logs app

Look for:

<pre>
[ledger] SQLite ready: /app/logs/v4call-ledger.db
[chat] SQLite ready: /app/logs/v4call-chat.db
v4call server running on 0.0.0.0:3000
[config] Server: yourcallapp (call.yourdomain.com)
[config] DM retention: 33 days | Room retention: 33 days | DM preview: 1
✓ Escrow key verified — matches @yourescrowaccount active key
✓ Escrow account @yourescrowaccount balance: 0.000 HBD
</pre>

If you see <code>SqliteError: unable to open database file</code> — run the chown command from Step 10 again then <code>docker compose restart app</code>.

Test HTTP is working:

curl http://call.yourdomain.com/debug-state

Should return: <code>{"lobbyUsers":[],"rooms":[]}</code>

If you can see the site in a browser over HTTP at this point — everything is working and ready for the certificate.

== Step 12: Get Your SSL Certificate ==

'''Before running certbot''', verify DNS and the challenge path are both working:

# Check DNS points to this server
nslookup call.yourdomain.com

# Test the challenge path
echo "test" > /opt/v4call/data/certbot/www/.well-known/acme-challenge/testfile
curl http://call.yourdomain.com/.well-known/acme-challenge/testfile

The curl command must return <code>test</code>. If it does not, Nginx is not running — check <code>docker compose ps</code> and <code>docker compose logs nginx</code>.

When both work, get the certificate. The <code>--entrypoint certbot</code> flag is required — without it, Docker runs the container's default renewal loop instead of the certonly command:

docker compose run --rm \
--entrypoint certbot \
certbot certonly \
--webroot \
-w /var/www/certbot \
-d call.yourdomain.com \
--email your@email.com \
--agree-tos \
--no-eff-email

Replace <code>call.yourdomain.com</code> with your domain and <code>your@email.com</code> with your email.

Success looks like:

<pre>
Requesting a certificate for call.yourdomain.com

Successfully received certificate.
Certificate is saved at: /etc/letsencrypt/live/call.yourdomain.com/fullchain.pem
Key is saved at: /etc/letsencrypt/live/call.yourdomain.com/privkey.pem
This certificate expires on 2026-07-09.
</pre>

Verify the files exist on the host:

ls /opt/v4call/data/certbot/conf/live/call.yourdomain.com/

Should show: <code>cert.pem chain.pem fullchain.pem privkey.pem README</code>

== Step 13: Enable HTTPS in Nginx ==

Now the certificate exists, update Nginx to serve HTTPS.

nano /opt/v4call/nginx/v4call.conf

Replace everything with the full HTTPS config:

<pre>
# HTTP — only used for certbot challenge and redirect to HTTPS
server {
listen 80;
server_name call.yourdomain.com www.call.yourdomain.com;

location /.well-known/acme-challenge/ {
root /var/www/certbot;
}

location / {
return 301 https://$host$request_uri;
}
}

# HTTPS — main app
server {
listen 443 ssl;
server_name call.yourdomain.com www.call.yourdomain.com;

# CHANGE PATH: ssl certs path uses your domain — find with: ls data/certbot/conf/live/
ssl_certificate /etc/letsencrypt/live/call.yourdomain.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/call.yourdomain.com/privkey.pem;

ssl_protocols TLSv1.2 TLSv1.3;
ssl_prefer_server_ciphers off;

add_header Strict-Transport-Security "max-age=63072000" always;
add_header X-Frame-Options DENY;
add_header X-Content-Type-Options nosniff;

# When user cancels the basic-auth login prompt, send them here
error_page 401 /info.html;

# info.html is served directly by Nginx — no auth, no proxy
location = /info.html {
root /usr/share/nginx/html;
auth_basic off;
}

# WebSocket — main client traffic
location /socket.io/ {
# Uncomment below to require username/password to enter site (testing only).
# See "Optional: Password Protect Your Server During Testing" section for setup.
#auth_basic "v4call — Private Testing";
#auth_basic_user_file /etc/nginx/.htpasswd;

proxy_pass http://app:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_cache_bypass $http_upgrade;
proxy_read_timeout 86400;
}

# Federation WebSocket — server-to-server, NEVER auth-protected.
# Peer v4call servers connect here to exchange presence/DMs/call invites.
# Trust validation happens inside the Node app (signed verify.json check
# + operator approval via /admin-peers.html). Do not add basic auth here —
# it would block all federation.
location /federation {
proxy_pass http://app:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_read_timeout 86400;
}

# Everything else — main HTTP traffic
location / {
# Uncomment below to require username/password to enter site (testing only).
#auth_basic "v4call — Private Testing";
#auth_basic_user_file /etc/nginx/.htpasswd;

proxy_pass http://app:3000;
proxy_http_version 1.1;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_read_timeout 300;
proxy_send_timeout 300;
}

# Logs failed and successful login attempts when .htpasswd is enabled
error_log /var/log/nginx/error.log warn;
access_log /var/log/nginx/access.log;
}
</pre>

* REPLACE <code>call.yourdomain.com</code> with your domain throughout (it appears 4 times — server_name lines and ssl_certificate paths).
* The <code>auth_basic</code> lines are '''commented out by default''' so federation and normal users work out-of-box. To enable password protection for private testing, see [[#Optional:_Password_Protect_Your_Server_During_Testing|the Optional section]] below — it shows how to uncomment them and create users.
* '''Never''' add <code>auth_basic</code> to the <code>/federation</code> block — it would block all peer v4call servers from connecting to you.

Save and restart Nginx:

docker compose restart nginx

Check the logs — you should see '''no''' <code>[emerg]</code> errors:

docker compose logs nginx

The last lines should show:

<pre>
nginx/1.x.x ...
start worker processes
</pre>

* If you see an error such as:
<pre>[emerg] 1#1: cannot load certificate "/etc/letsencrypt/live/call.yourdomain.com/fullchain.pem": BIO_new_file() failed (SSL: error:80000002:system library::No such file or directory:calling fopen(/etc/letsencrypt/live/call.yourdomain.com/fullchain.pem, r) error:10000080:BIO routines::no such file)</pre>

* Make sure you edited <code>nginx/v4call.conf</code> correctly.
* To find the path for your SSL certs look in path <code>data/certbot/conf/live/</code>
* There are 4 lines to check in <code>nginx/v4call.conf</code>:
** <code>server_name call.yourdomain.com www.call.yourdomain.com;</code> (HTTP block)
** <code>server_name call.yourdomain.com www.call.yourdomain.com;</code> (HTTPS block)
** <code>ssl_certificate /etc/letsencrypt/live/call.yourdomain.com/fullchain.pem;</code>
** <code>ssl_certificate_key /etc/letsencrypt/live/call.yourdomain.com/privkey.pem;</code>
* When done restart nginx with: <code>docker compose restart nginx</code>

== Step 14: Set Up SSL Auto-Renewal ==

Let's Encrypt certificates expire after 90 days. A cron job renews them automatically.

crontab -e

Add this line at the bottom:

0 3 * * * cd /opt/v4call && docker compose run --rm --entrypoint certbot certbot renew --quiet && docker compose exec nginx nginx -s reload

Save and exit. This runs at 3am every day, renews if the cert is close to expiry, and reloads Nginx to pick up the new certificate.

== Step 15: Test Everything is Working ==

Test HTTPS:

curl https://call.yourdomain.com/debug-state

Should return: <code>{"lobbyUsers":[],"rooms":[]}</code>

Test admin access:

curl "https://call.yourdomain.com/admin/balance?key=YOUR_ADMIN_KEY"

Should return your escrow account balance.

Open your browser and go to <code>https://call.yourdomain.com</code>

You should see the v4call login page with:
* A padlock icon in the browser address bar
* A green '''⚡ Sign in with Keychain''' button (if Hive Keychain is installed)
* A manual posting key login option below it
* A '''📖 New here? Learn the v4call basics →''' link at the bottom

Log in with Hive Keychain or a posting key to confirm the login flow works. 🎉

== Step 16: Set Up Your Call Rates on Hive ==

For callers to be charged when they ring you, publish your rates on the Hive blockchain:

# Make sure Hive Keychain is installed in your browser
# Go to <code>https://call.yourdomain.com/rate-editor.html</code>
# Enter your Hive username
# Set your rates — ring fee, connect fee, duration rate per hour, minimum credit deposit
# Set <code>PLATFORM-FEE</code> to at least your server's <code>DEFAULT_PLATFORM_FEE</code> percentage (e.g. <code>10</code> for 10%). If you set it lower, paid contacts to your account will be rejected on this server.
# Optionally add custom token sections (e.g. <code>[TOKEN:CNOOBS]</code>) to offer discounted rates for callers who hold your token
# Click '''Generate''' to preview the rates block
# Click '''Post to Hive''' — Keychain will ask you to approve the post

This creates a post titled <code>v4call-rates</code> on your Hive blog. Your server reads this post automatically.

To verify your server read the rates correctly:

https://call.yourdomain.com/debug-rates/yourusername

To test with a specific caller (checks their token balances too):

https://call.yourdomain.com/debug-rates/yourusername?caller=theirusername&type=voice

You should see your rates as JSON, including which currency and rates apply for that caller.

== Step 17: Federation Setup (Optional) ==

If you want your server to talk to other v4call servers — so users on different servers can call/DM each other — set up federation. This is optional. A standalone server works fine without it.

Federation has two trust steps:

# '''Domain proof''' — you publish a signed JSON file at <code>https://yourdomain.com/.well-known/v4call-server.json</code> proving that your Hive account controls this domain
# '''Directory listing''' — you publish a Hive post tagged <code>v4call-server</code> announcing your server exists, so other operators can discover you

'''Important escrow rule''': the <code>ESCROW_ACCOUNT</code> in your <code>.env</code> must match the <code>ESCROW:</code> field in your users' rates posts. The active key for that escrow has to live on '''this''' server. If a user's rates post points at a different escrow than what your server holds the key for, paid calls/DMs to that user will fail (your server can't disburse from an escrow it doesn't control).

=== Step 17a: Generate and Host the Verify File ===

# Open <code>https://yourdomain.com/server-sign.html</code> in a browser with Hive Keychain installed
# Fill in: Hive account (same as <code>SERVER_HIVE_ACCOUNT</code>), domain, escrow account, fee account, federation WS URL (<code>wss://yourdomain.com/federation</code>)
# Click '''⚡ Sign with Hive Keychain'''
# Click '''⬇ Download''' — saves <code>v4call-server.json</code>
# Upload to your server, replacing the placeholder file. From your local machine:
scp v4call-server.json root@yourvps:/opt/v4call/public/.well-known/

(Or use any other transfer method you prefer — SFTP client, paste via SSH, etc.)

Verify it's served:
curl https://yourdomain.com/.well-known/v4call-server.json

You should see your signed JSON. If you see <code>404</code>, check the file is at exactly <code>public/.well-known/v4call-server.json</code> — the directory uses a '''hyphen''', not an underscore (RFC 8615), and the filename must be exactly <code>v4call-server.json</code>.

Rebuild so the file is baked into the Docker image:
docker compose down && docker compose build --no-cache && docker compose up -d

'''Tip''': commit the generated file to your git repo so future fresh installs include it automatically. It contains only public data — safe to commit. The placeholder shipped in the repo is overwritten by your file.

=== Step 17b: Announce on Hive ===

For other operators to discover you, publish a Hive post advertising your server:

# After signing in Step 17a, click the '''📡 Announce on Hive →''' link on the signer output card (auto-fills the announce page)
# Or open <code>https://yourdomain.com/server-announce.html</code> directly
# Confirm the prefilled values
# Click '''📡 Post to Hive''' — Keychain will broadcast the post

The post lives forever on Hive. If your config changes, just post a new one — the most recent post per Hive account wins. No need to delete old posts (Hive posts are effectively permanent anyway).

=== Step 17c: Connect to Known Peers (Manual Mode) ===

Skip the discovery step and go straight to a known peer by adding their WebSocket URL to <code>FEDERATION_PEERS</code> in <code>.env</code>:
FEDERATION_PEERS=wss://otherserver.com/federation

Both servers must list each other. Rebuild after editing <code>.env</code>:
docker compose down && docker compose build --no-cache && docker compose up -d

Servers in <code>FEDERATION_PEERS</code> are auto-approved on startup — they bypass the manual approval step.

=== Step 17d: Discover and Approve Peers (Auto Mode) ===

Your server scans Hive for <code>v4call-server</code> posts on startup and every 2 hours. Discovered peers are NOT auto-connected — you must approve each one.

# Open <code>https://yourdomain.com/admin-peers.html</code>
# Paste your <code>ADMIN_KEY</code> (from <code>.env</code>) and click '''🔄 Load / Refresh'''
# Each discovered peer shows a card with verification status, escrow, fee account, post age
# Click '''✓ Approve''' to add them to your federation
# Click '''✗ Revoke''' to remove an approved peer

Approvals persist to <code>/app/logs/approved-peers.json</code> so they survive container restarts.

=== Federation Health Check ===

Watch the federation logs:
docker compose logs -f app | grep -E "\[federation\]|\[discovery\]|\[peers\]"

Healthy startup looks like:

<pre>
[federation] Approved peers: peer-domain.com
[federation] Connecting to wss://peer-domain.com/federation...
[federation] Outbound connected: wss://peer-domain.com/federation
[federation] ✓ Peer verified: @peer-domain.com (signer: @peer-account, escrow: @peer-escrow)
[discovery] Hive returned 2 post(s) under v4call-server tag
[discovery] Scan complete — 2 v4call-server post(s), 2 verified
</pre>

When a user logs in on either server, you should see:

<pre>
[federation] → user-online @username → 1 peer(s) (on their home server)
[federation] ← user-online @username@theirhome.com (on your server)
</pre>

== Feature Guide: What Your Server Can Do ==

This section explains all the features available in v4call and how they work. No code changes needed — everything described here is built in and ready to use.

=== Login Options ===

v4call supports two ways to sign in:

* '''Hive Keychain''' (recommended) — click the green '''⚡ Sign in with Keychain''' button. Keychain signs a challenge to prove your identity. No key paste needed. After login, a 🔑 panel appears in the lobby where you can optionally enter your posting key to unlock encrypted messaging (Keychain cannot expose private keys, so encryption needs the key entered once per session).
* '''Manual posting key''' — paste your Hive posting private key (starts with <code>5J</code>) directly. The key stays in browser session memory only — never sent to the server.

Both methods verify your identity against the Hive blockchain.

=== Voice and Video Calls ===

Each online user in the lobby shows three action buttons:

* '''📞 Green phone icon''' — start a '''voice-only''' call (audio, no camera)
* '''🎥 Blue camera icon''' — start a '''video''' call (audio + camera)
* '''💬 Purple chat bubble icon''' — open the '''DM panel''' to send a direct message

Voice calls request microphone only — no camera permission prompt. Video calls request both. The caller and callee can have different call types — the type is set by whoever initiates the call.

Separate rates can be set for voice and video calls in the rates post (voice is typically cheaper).

Federated users (on a different v4call server) appear in the lobby with a small server-domain badge under their username. The call/DM buttons work the same — federation routing is transparent.

=== Direct Messages (DMs) ===

Click the purple 💬 button next to any online user to open the DM panel. DMs are end-to-end encrypted using Hive posting keys — the server stores only ciphertext it cannot read.

'''Chat storage:''' DMs are stored on the server in an encrypted database (<code>v4call-chat.db</code>) for up to <code>DM_RETENTION_DAYS</code> (default: 33 days). Both sender and recipient get their own encrypted copy stored, so both can retrieve their history later.

'''Unread alerts:''' When you log in, if you have unread DMs, a popup appears showing how many messages from how many users. Click a username in the popup to open their DM history.

'''DM previews:''' The last <code>DM_PREVIEW_COUNT</code> messages per conversation are loaded into the lobby chat on login, so you can see recent activity at a glance. Set to <code>0</code> in <code>.env</code> to disable.

'''Full history:''' Click the DM button for any user to load the complete conversation history, shown between "— DM history —" dividers.

=== Rooms ===

Users can create private rooms by selecting users in the lobby (toggle switch) and clicking '''Create & Invite'''. Rooms support encrypted messaging, video, and voice.

'''Room history:''' When a new user joins a room, they see past messages — broadcasts in full, encrypted messages only if they were addressed to them. A "— earlier messages —" divider separates history from live messages.

'''Ephemeral rooms:''' A warning banner at the top of every room says: "⚠ Room is ephemeral — if all users leave, the room and its history are deleted. New members can only read messages encrypted to their key." When the last person leaves a room, all stored messages for that room are deleted from the database.

=== Custom Token Payments (Hive-Engine) ===

v4call supports payment in any Hive-Engine token, not just HBD. This is configured per-user in their rates post using <code>[TOKEN:SYMBOL]</code> sections.

'''How it works:'''
# A user (e.g. @cnoobz) creates a custom token on Hive-Engine (e.g. CNOOBS)
# In their rates post, they add a <code>[TOKEN:CNOOBS]</code> section with lower rates than their default HBD rates
# When a caller who holds CNOOBS contacts @cnoobz, the server detects the token balance and offers the token rates
# If the caller holds multiple qualifying tokens, '''all options are shown''' in a currency picker — the caller chooses which to pay with
# The payment goes through Hive Keychain as a <code>custom_json</code> Hive-Engine transfer

'''For the escrow account:''' Your escrow account needs to hold some of each custom token that users on your server accept. Token payouts (to the callee) and refunds (to the caller) are sent from the escrow account's token balance, just like HBD.

'''Payment picker:''' When multiple payment options exist (e.g. CNOOBS at 1 per message, HBD at 100000 per message), the payment modal shows clickable currency buttons so the caller can see all rates and choose the best option.

=== Platform Fee System ===

The platform fee is how your server earns revenue from paid calls and DMs.

'''How it works:'''
* Your server's <code>DEFAULT_PLATFORM_FEE</code> in <code>.env</code> is the '''minimum''' percentage your server accepts (e.g. <code>10</code> = 10%)
* Each user sets <code>PLATFORM-FEE</code> in their Hive rates post — this is the maximum fee they are willing to pay to a server
* If the user's posted fee is '''lower''' than your server's minimum → '''rejected'''. The caller sees a message explaining the mismatch, and the callee is told to raise their fee.
* If the user's posted fee '''meets or exceeds''' your server's minimum → '''accepted''', and '''the server charges its own rate''' (the minimum), not the user's higher number. The callee gets the best price.
* If the user has '''no <code>PLATFORM-FEE</code> line''' in their rates post → the server's default is used automatically. No mismatch.
* '''Free contacts''' (no payment involved) are never affected by fee enforcement.

'''Why this matters for federation:''' Different servers can set different platform fees. Users can shop around — pick a server with a fee they find agreeable. This creates a free market for server operators.

'''Example:'''
* Your server: <code>DEFAULT_PLATFORM_FEE=3</code> (3%)
* @alice posts: <code>PLATFORM-FEE: 5%</code> → accepted, server charges 3% (best price for alice)
* @bob posts: <code>PLATFORM-FEE: 1%</code> → rejected, bob needs to raise to at least 3%
* @charlie has no fee line → defaults to 3%, automatically accepted

=== Federation ===

Federation lets users on different v4call servers see, call, and DM each other. Each server independently:

* Holds its own escrow account (the active key never leaves the server it belongs to)
* Verifies and disburses payments through its own escrow
* Takes the platform fee for calls/DMs received by its own users

Cross-server payments work like this: caller pays the callee's escrow on Hive (read from the callee's rates post), the callee's server verifies the payment on-chain and forwards a notification, both servers exchange call/DM signalling, and the callee's server disburses callee-net + platform-fee from its own escrow at call end (with refunds going cross-server back to the caller as a normal Hive transfer).

WebRTC media stays peer-to-peer — neither server sees the audio/video.

See [[#Step_17:_Federation_Setup_(Optional)|Step 17: Federation Setup]] for the setup steps.

== Admin Configuration Reference ==

All settings are in the <code>.env</code> file. After changing any value, rebuild:

docker compose down && docker compose build --no-cache && docker compose up -d

{| class="wikitable"
|-
! Variable !! Default !! Description
|-
| <code>SERVER_NAME</code> || <code>v4call</code> || Display name for your server
|-
| <code>SERVER_DOMAIN</code> || <code>v4call.com</code> || Your server's domain
|-
| <code>SERVER_HIVE_ACCOUNT</code> || <code>v4call</code> || Hive account that receives platform fees (and signs your federation verify file)
|-
| <code>ESCROW_ACCOUNT</code> || <code>v4call-escrow</code> || Hive account that holds funds during calls. The active key for this account must live on '''this''' server.
|-
| <code>V4CALL_ESCROW_KEY</code> || ''(none)'' || Active private key for the escrow account. '''Required.'''
|-
| <code>ADMIN_KEY</code> || ''(none)'' || Password for admin endpoints (<code>/admin/balance</code>, <code>/admin/ledger</code>, <code>/admin/peers</code>)
|-
| <code>DEFAULT_PLATFORM_FEE</code> || <code>10</code> || Server's minimum platform fee percentage
|-
| <code>FEDERATION_PEERS</code> || ''(blank)'' || Comma-separated peer WebSocket URLs (e.g. <code>wss://peer.com/federation</code>). Listed peers are auto-approved on startup. Blank = standalone mode.
|-
| <code>DM_RETENTION_DAYS</code> || <code>33</code> || Days to keep stored DMs before cleanup
|-
| <code>ROOM_RETENTION_DAYS</code> || <code>33</code> || Days to keep stored room messages before cleanup
|-
| <code>DM_PREVIEW_COUNT</code> || <code>1</code> || Recent DMs per conversation shown on login (0 = off)
|-
| <code>HIVE_API</code> || ''(blank)'' || Override primary Hive API node. Blank = auto-select from built-in list
|-
| <code>MAX_CALL_DURATION_MIN</code> || <code>120</code> || Maximum call length in minutes before auto-disconnect
|-
| <code>CALL_COOLDOWN_MS</code> || <code>30000</code> || Milliseconds between call attempts to same user
|-
| <code>PAYMENT_VERIFY_RETRIES</code> || <code>3</code> || Number of attempts to verify a blockchain payment
|-
| <code>PAYMENT_VERIFY_DELAY_MS</code> || <code>5000</code> || Delay between verification retry attempts
|}

=== Debug & Admin Endpoints ===

These are useful for testing without making actual calls:

* <code>/debug-state</code> — shows current lobby users and active rooms (no auth required)
* <code>/debug-rates/USERNAME</code> — shows parsed rates for a user
* <code>/debug-rates/USERNAME?caller=CALLER&type=voice</code> — shows what rates a specific caller would receive (checks token balances too)
* <code>/admin/balance?key=YOUR_ADMIN_KEY</code> — shows escrow account HBD balance
* <code>/admin/ledger?key=YOUR_ADMIN_KEY</code> — shows recent payment records
* <code>/admin/peers?key=YOUR_ADMIN_KEY</code> — JSON list of discovered + approved federation peers
* <code>/admin/peers/approve?key=YOUR_ADMIN_KEY&domain=peer.com</code> (POST) — approve a discovered peer
* <code>/admin/peers/revoke?key=YOUR_ADMIN_KEY&domain=peer.com</code> (POST) — revoke approval
* <code>/admin/peers/rescan?key=YOUR_ADMIN_KEY</code> (POST) — force a Hive directory rescan

=== Operator Tool Pages ===

* <code>/rate-editor.html</code> — generate your <code>v4call-rates</code> Hive post
* <code>/server-sign.html</code> — generate your signed federation verify file
* <code>/server-announce.html</code> — publish your server announcement on Hive
* <code>/admin-peers.html</code> — UI for federation peer approve/revoke/rescan
* <code>/info.html</code> — public landing page (shown to users who hit the basic-auth login cancel)

== Updating Your Server ==

'''Important:''' Always use <code>docker compose down</code> before rebuilding. Without this step, Docker may reuse the old container even after a rebuild, and your changes will not take effect.

cd /opt/v4call
docker compose down
docker compose build --no-cache
docker compose up -d

Your data, SQLite databases and <code>.env</code> config are preserved — they live in <code>data/logs/</code> which is a mounted volume.

To pull updates from GitHub and deploy:

cd /opt/v4call
git pull
docker compose down
docker compose build --no-cache
docker compose up -d

To push your own customisations to GitHub:

# On your local computer after making changes:
git add .
git commit -m "describe what you changed"
git push

# On the VPS:
cd /opt/v4call
git pull
docker compose down
docker compose build --no-cache
docker compose up -d

== Common Problems and Fixes ==

=== Changes not showing after rebuild ===

If you edited <code>server.js</code> or <code>index.html</code> but changes are not visible, you probably forgot to bring Docker down first. <code>docker compose restart</code> and even <code>docker compose up -d --build</code> can reuse old containers.

'''Fix:'''

docker compose down
docker compose build --no-cache
docker compose up -d

=== SqliteError: unable to open database file ===

The app container runs as UID 1000 but the logs directory was created by root. Fix:

chown -R 1000:1000 /opt/v4call/data/logs
docker compose restart app

=== Certbot says "No renewals were attempted" ===

The certbot container's default behaviour is a renewal loop. Your <code>certonly</code> command is being ignored. Always use <code>--entrypoint certbot</code> to override it:

docker compose run --rm --entrypoint certbot certbot certonly ...

Without <code>--entrypoint certbot</code> the container runs its renewal script instead of your command.

=== Nginx crashes with "cannot load certificate: No such file" ===

You added the HTTPS server block before getting the certificate. Nginx reads all server blocks at startup — if the cert file doesn't exist, the entire process fails.

Fix: revert nginx config to HTTP-only (Step 9), restart Nginx, get the certificate (Step 12), then re-add HTTPS (Step 13).

=== Webroot challenge test returns nothing ===

Nginx is not running. Check:

docker compose ps
docker compose logs nginx

If Nginx is restarting — it has the HTTPS config with a missing cert file. Use the HTTP-only config.

=== "Escrow key does NOT match" warning on startup ===

The key in <code>.env</code> is the wrong type. You need the '''active''' private key, not the posting or owner key. Find it in your Hive wallet → Keys & Permissions → Active. It starts with <code>5K</code>.

=== Site unreachable on port 443 ===

Check that the certificate was issued:

ls /opt/v4call/data/certbot/conf/live/

Should show a folder with your domain name. If empty — go back to Step 12.

=== npm ci error during Docker build ===

The <code>npm ci</code> command requires a <code>package-lock.json</code> file. The project uses <code>npm install</code> instead. If you see this error, check your <code>Dockerfile</code> — it should say <code>npm install</code> not <code>npm ci</code>.

=== Custom token payments not working ===

If token rates are detected but payments fail:
* Check the escrow account holds the token — send some tokens to your escrow account on Hive-Engine
* Check the token symbol matches exactly (case-sensitive) between the rates post and Hive-Engine
* Check the server logs: <code>docker compose logs app | grep -i "token\|cnoobs\|escrow-token"</code>
* The Hive-Engine API endpoint must be <code>https://api.hive-engine.com/rpc/contracts</code> — this is built into the code

=== [encrypted — unlock with 🔑 key panel to read] ===

You logged in with Hive Keychain. Keychain does not expose private keys, so encrypted messages cannot be decrypted without your posting key. Enter your posting key in the 🔑 panel at the bottom of the online users list. The key stays in browser session memory only — it is needed once per session.

=== Federation peer verification fails with HTTP 404 ===

Logs show:
[federation] ✗ Peer verification failed for X: Cannot fetch verify.json: HTTP 404

The peer's <code>/.well-known/v4call-server.json</code> file isn't being served. Common causes:

* '''Wrong directory name''' — must be <code>.well-known</code> with a hyphen, not <code>.well_known</code> with an underscore (RFC 8615).
* '''Wrong filename''' — must be <code>v4call-server.json</code>, not <code>verify.json</code> or anything else. The verifier code looks for this exact name.
* '''Not in the Docker image''' — file lives at <code>public/.well-known/v4call-server.json</code> in the repo and is copied into the image at build time. After placing the file, rebuild: <code>docker compose down && docker compose build --no-cache && docker compose up -d</code>.
* '''Placeholder not replaced''' — the repo ships with a tiny placeholder. You must overwrite it with your own signed file from <code>/server-sign.html</code> before federation will work.

Test from outside the container:
curl https://yourdomain.com/.well-known/v4call-server.json

Should return your signed JSON, not <code>404</code> or the placeholder.

=== Federation connection flapping (rapid disconnect/reconnect loop) ===

If logs show repeated <code>Outbound connected</code> followed by <code>Disconnected — retry in 2s</code> with no successful handshake, check verify.json:

* Is the file present at the path above?
* Does its <code>signature</code> match the Hive account's posting key? Test by pasting the JSON into the '''Verify''' panel on <code>/server-sign.html</code> — should say "✓ Signature valid".
* Does <code>hive_account</code> in the JSON match <code>SERVER_HIVE_ACCOUNT</code> in the peer's .env? They must match.

=== Federation peer connects but my user can't be seen on the other side ===

If two servers connect successfully but a user on Server A doesn't appear in Server B's lobby, check:

* Server A logs: <code>[federation] → user-online @username → 1 peer(s)</code> — confirms A broadcast the presence
* Server B logs: <code>[federation] ← user-online @username@A.com</code> — confirms B received it

If A logs the broadcast but B never received it, the federation socket might be one-way. Check both servers have approved each other (visible at <code>/admin-peers.html</code>).

=== Federated paid call/DM fails silently after payment ===

Most common cause: the user's <code>v4call-rates</code> post declares an <code>ESCROW:</code> account whose active key isn't on their home server. The caller's payment lands in that escrow correctly, but no server can disburse from it.

Fix: have the user re-post their rates with an <code>ESCROW:</code> matching their home server's <code>ESCROW_ACCOUNT</code> in <code>.env</code>. Or migrate that escrow account's active key to the right server.

The federation handshake also surfaces this as a clear error message via the escrow-mismatch guard — check the caller-side server logs for it.

=== Discovery scanner finds 0 posts ===

If <code>/admin-peers.html</code> shows "No v4call-server posts discovered yet" even after rescanning:

* Click '''🔍 Rescan Hive now''' and watch logs: <code>docker compose logs -f app | grep discovery</code>
* Expected: <code>[discovery] Hive returned N post(s) under v4call-server tag</code>
* If N = 0, no Hive posts exist with that tag yet — publish your own via <code>/server-announce.html</code>
* If you see <code>[discovery] No response from Hive tag query</code>, the Hive API is unreachable from inside the container. Test container DNS / outbound HTTPS by hitting any external HTTPS URL from the container.

== Quick Reference ==

{| class="wikitable"
|-
! Command !! What it does
|-
| <code>docker compose ps</code> || Show status of all containers
|-
| <code>docker compose logs app</code> || Show app logs
|-
| <code>docker compose logs nginx</code> || Show Nginx logs
|-
| <code>docker compose logs -f app</code> || Watch live logs (Ctrl+C to stop)
|-
| <code>docker compose down</code> || Stop everything ('''always do this before rebuilding''')
|-
| <code>docker compose build --no-cache</code> || Rebuild without using cached layers
|-
| <code>docker compose up -d</code> || Start everything in background
|-
| <code>docker compose down && docker compose build --no-cache && docker compose up -d</code> || Full rebuild cycle (use after any code change)
|-
| <code>docker compose restart nginx</code> || Restart Nginx after config-only changes (no rebuild needed)
|-
| <code>chown -R 1000:1000 /opt/v4call/data/logs</code> || Fix SQLite write permissions
|-
| <code>docker compose run --rm --entrypoint certbot certbot certificates</code> || List SSL certificates
|-
| <code>curl http://yourdomain.com/.well-known/acme-challenge/testfile</code> || Test certbot webroot works
|-
| <code>docker compose logs app | grep -i "token\|escrow"</code> || Check token payment logs
|-
| <code>docker compose logs -f app | grep -E "\[federation\]|\[discovery\]"</code> || Watch federation activity
|-
| <code>curl https://yourdomain.com/.well-known/v4call-server.json</code> || Check verify file is served
|-
| <code>https://yourdomain.com/server-sign.html</code> || Generate signed federation verify file
|-
| <code>https://yourdomain.com/server-announce.html</code> || Publish server to Hive directory
|-
| <code>https://yourdomain.com/admin-peers.html</code> || Manage federation peer approvals
|}

== Optional: Password Protect Your Server During Testing ==

<div class="toccolours mw-collapsible mw-collapsed">
<strong>Optional: Password Protect Your Server During Testing (HTTP Basic Auth)</strong>
<div class="mw-collapsible-content">

During development and testing you may want to restrict access so only people you invite can use your server. This uses Nginx HTTP Basic Auth — a simple username and password prompt that appears before the v4call login screen.

When a visitor cancels the login prompt they are shown a public <code>info.html</code> page where they can read about the project and request access.

'''Important''': do NOT add basic auth to the <code>/federation</code> location block. Federation peers cannot supply HTTP credentials and the connection will fail. The auth lines below are added only to <code>/socket.io/</code> and <code>/</code>.

*<b> Step 1 — Install the htpasswd tool</b>

<code>apt install -y apache2-utils</code>

*<b> Step 2 — Create the password file and add your first user </b>

<code>htpasswd -c /opt/v4call/nginx/.htpasswd yourusername</code>

You will be prompted to enter and confirm a password. The <code>-c</code> flag creates the file. Do not use <code>-c</code> again or it will overwrite the file and delete existing users.

To add more users later:

<code>htpasswd /opt/v4call/nginx/.htpasswd anotherusername</code>

To remove a user:

<code>htpasswd -D /opt/v4call/nginx/.htpasswd username</code>

*<b> Step 3 — Create the public info page </b>

<code>nano /opt/v4call/public/info.html</code>

Paste your HTML content — a page explaining the project and how to request access. This page is served publicly without a password so visitors who cancel the login prompt can still read it.

*<b> Step 4 — Mount the files into the Nginx container </b>

Edit <code>docker-compose.yml</code> and add two lines to the nginx volumes section:

<pre>
nginx:
volumes:
- ./nginx/v4call.conf:/etc/nginx/conf.d/default.conf:ro
- ./nginx/.htpasswd:/etc/nginx/.htpasswd:ro # add this
- ./public/info.html:/usr/share/nginx/html/info.html:ro # add this
- ./data/certbot/conf:/etc/letsencrypt:ro
- ./data/certbot/www:/var/www/certbot:ro
</pre>

*<b> Step 5 — Enable auth in your Nginx config </b>

The HTTPS config from Step 13 already includes the <code>auth_basic</code> lines, just commented out. Open <code>nginx/v4call.conf</code> and uncomment them in BOTH the <code>/socket.io/</code> and <code>/</code> location blocks (4 lines total, two pairs):

<pre>
auth_basic "v4call — Private Testing";
auth_basic_user_file /etc/nginx/.htpasswd;
</pre>

'''Do not''' uncomment auth in the <code>/federation</code> block — leave it as-is.

*<b> Step 6 — Recreate the Nginx container to pick up the new volume mounts </b>

'''Important''': <code>docker compose restart nginx</code> is not enough — it reuses the old container and ignores new volume mounts. You must recreate it:

<code>docker compose down && docker compose up -d</code>

After this, verify the files are mounted inside the container:

<code>docker compose exec nginx ls /usr/share/nginx/html/</code>

You should see <code>info.html</code> listed alongside <code>50x.html</code> and <code>index.html</code>.

*<b> Step 7 — Test it works </b>

<code>curl -o /dev/null -s -w "%{http_code}" https://call.yourdomain.com/</code>

Should return <code>401</code> (login required).

<code>curl -o /dev/null -s -w "%{http_code}" https://call.yourdomain.com/info.html</code>

Should return <code>200</code> (public, no auth needed).

<code>curl -u youruser:yourpassword -o /dev/null -s -w "%{http_code}" https://call.yourdomain.com/</code>

Should return <code>200</code> (correct credentials accepted).

*<b> Managing users without restarting </b>

After adding or removing users from the <code>.htpasswd</code> file, reload Nginx config without downtime:

<code>docker compose exec nginx nginx -s reload</code>

No restart needed — Nginx re-reads the <code>.htpasswd</code> file on every request anyway.

*<b> Keep .htpasswd out of GitHub </b>

The password file should never be committed to your repository. It's already in the project's <code>.gitignore</code>, but if you forked, double-check:

<code>echo "nginx/.htpasswd" >> /opt/v4call/.gitignore</code>

*<b> Removing auth when you go public </b>

When you are ready to open your server to everyone, simply re-comment the <code>auth_basic</code> lines from <code>nginx/v4call.conf</code> and reload:

<code>docker compose exec nginx nginx -s reload</code>

No other changes needed.

</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed">
'''How to check if anyone tried to log in (failed attempts) or successfully logged in with .htpasswd on Nginx in Docker'''

<div class="mw-collapsible-content">

'''Important Tip:''' Always run these commands in the same folder where your <code>docker-compose.yml</code> file is located. If you are in the wrong directory the commands will not find your container and nothing will show up.

* ''''' Basic Commands '''''

; '''See everything live (good while testing)'''
: <code>docker compose logs -f nginx</code><br>
: <code>-f</code> means "follow/live" – new log lines appear automatically. Remove <code>-f</code> if you only want to read the current logs once and stop.

; '''Best command to watch failed login attempts (people guessing passwords)'''
: <code>docker compose logs -f nginx | grep -E "mismatch|not found|401"</code>

; '''See who successfully logged in'''
: <code>docker compose logs nginx | grep "remote_user"</code>

; '''Combined view – most useful for daily checking (failed + successful)'''
: <code>docker compose logs -f --tail=100 nginx | grep -E "(mismatch|not found|remote_user|401)"</code>

* ''''' What the Logs Look Like '''''

'''Failed attempt (wrong password):'''
<pre>2026/04/17 01:23:45 [error] ... user "admin": password mismatch, client: 185.123.45.67, ...</pre>

'''Failed attempt (wrong username):'''
<pre>2026/04/17 01:24:12 [error] ... user "hacker123" was not found in "/etc/nginx/.htpasswd", client: 45.67.89.10, ...</pre>

'''Successful login:'''
<pre>... "GET /protected/ HTTP/1.1" 200 ... remote_user: "myuser" ...</pre>

* ''''' How to Customise These Commands '''''

* Change <code>nginx</code> to the exact name of your service if it is different in docker-compose.yml.
* Remove <code>-f</code> to read the full log once without live following.
* Change <code>--tail=100</code> to <code>--tail=500</code> (or any number) to show more or fewer old lines.
* Add or remove words in the <code>grep</code> part to filter differently.
Examples:
* Only failed attempts: <code>grep -E "mismatch|not found"</code>
* Only 401 errors: <code>grep " 401 "</code>
* Everything auth related: <code>grep -E "(auth|password|mismatch|not found|remote_user)"</code>

* '''''Quick Copy-Paste Commands '''''

# Watch failed guesses live
docker compose logs -f nginx | grep -E "mismatch|not found|401"

# Check successful logins
docker compose logs nginx | grep "remote_user"

# Combined quick check (recommended)
docker compose logs -f --tail=100 nginx | grep -E "(mismatch|not found|remote_user|401)"

</div>
</div>

[[Category:Docker]]
[[Category:Ubuntu]]
[[Category:Hive]]
[[Category:v4call]]
[[Category:WebRTC]]

Basic Html JavaScript POPUP warning Accept

2026-04-19T19:24:55Z

AwesomO: Created page with "3 parts ==Part one== * This is placed in the <head> </head> at the top of index.html contains css <pre> <style> #overlay { position: fixed; top: 0; left: 0; width: 100%; height: 100%; background: rgba(0,0,0,0.85); color: white; z-index: 10000; display: flex; align-items: center; justify-content: center; text-align: center; } .popup-box { background: #222; padding: 30px; border-radius: 10px; border: 1px solid #444; } button { padding: 10px 20px; curso..."

3 parts

==Part one==
* This is placed in the <head> </head> at the top of index.html contains css
<pre>
<style>
#overlay {
position: fixed; top: 0; left: 0; width: 100%; height: 100%;
background: rgba(0,0,0,0.85); color: white; z-index: 10000;
display: flex; align-items: center; justify-content: center; text-align: center;
}
.popup-box { background: #222; padding: 30px; border-radius: 10px; border: 1px solid #444; }
button { padding: 10px 20px; cursor: pointer; background: #007bff; color: white; border: none; border-radius: 5px; }
.hidden { display: none !important; }
</style>
</pre>

==part two==
* This is placed in/at the top of the <body> </body> section, contains message.
<pre>

<div id="overlay">
<div class="popup-box">
<h2>Welcome to Complete Noobs!</h2>
<p>We use cookies to track traffic. Are you 21 or older?</p>
<p>By accepting you are entering at your own risk</p>
<button onclick="acceptAndHide()">Yes, I Accept & I'm Over 21 & am aware you are noobs and are still learning i enter at my own risk</button>
<p>→ <a href="https://www.google.com" >No Thank You - take me to Google</a></p>
</div>
</div>
</pre>

==part 3==
* This is placed in/at the bottom of the <body> </body> section, contains js script.

<pre>

<script>
function acceptAndHide() {
// Save the choice in the browser's "localStorage" so it doesn't pop up again
localStorage.setItem('gate_passed', 'true');
document.getElementById('overlay').classList.add('hidden');
}

// On page load, check if they already clicked "Yes"
window.onload = function() {
if (localStorage.getItem('gate_passed') === 'true') {
document.getElementById('overlay').classList.add('hidden');
}
};
</script>
</pre>

==use case==
* Sample use case

<pre>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>My Projects - Status Update</title>
<style>
body {
font-family: Arial, Helvetica, sans-serif;
max-width: 800px;
margin: 40px auto;
padding: 20px;
line-height: 1.6;
color: #333;
}
h1 {
text-align: center;
color: #222;
}
h2 {
color: #444;
border-bottom: 2px solid #eee;
padding-bottom: 8px;
}
a {
color: #0066cc;
text-decoration: none;
}
a:hover {
text-decoration: underline;
}
.status {
font-style: italic;
color: #555;
}
</style>

<style>
#overlay {
position: fixed; top: 0; left: 0; width: 100%; height: 100%;
background: rgba(0,0,0,0.85); color: white; z-index: 10000;
display: flex; align-items: center; justify-content: center; text-align: center;
}
.popup-box { background: #222; padding: 30px; border-radius: 10px; border: 1px solid #444; }
button { padding: 10px 20px; cursor: pointer; background: #007bff; color: white; border: none; border-radius: 5px; }
.hidden { display: none !important; }
</style>

</head>


<script async src="https://www.googletagmanager.com/gtag/js?id=G-YXYQE65XY1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());

gtag('config', 'G-YXYQE65XY1');
</script>

<body>

<div id="overlay">
<div class="popup-box">
<h2>Welcome to Complete Noobs!</h2>
<p>We use cookies to track traffic. Are you 21 or older?</p>
<p>By accepting you are entering at your own risk</p>
<button onclick="acceptAndHide()">Yes, I Accept & I'm Over 21 & am aware you are noobs and are still learning i enter at my own risk</button>
<p>→ <a href="https://www.google.com" >No Thank You - take me to Google</a></p>
</div>
</div>

<h1>Project Status</h1>

<h2>CompleteNoobs</h2>
<p class="status">Currently on hold due to lack of free time.</p>
<p>It will be relaunched as <strong>cnoobs.com</strong> running inside a Docker container.</p>
<p>Future plans include a possible soft-fork of MediaWiki that allows Hive accounts holding a certain amount of CNOOBS coins to post and edit pages.
I'm also interested in integrating the Hive rewards system for content creators and exploring reward splits between users.</p>
<p>Additional custom features being considered:</p>
<ul>
<li>Custom tags for embedding IPFS content to keep the wiki database smaller and more portable:</li>
<ul>
<li><code><ipfs_video>ipfs_addr</ipfs_video></code></li>
<li><code><ipfs_pic>ipfs_addr</ipfs_pic></code></li>
<li><code><ipfs_audio>ipfs_addr</ipfs_audio></code></li>
<li><code><ipfs_file>ipfs_addr</ipfs_file></code></li>
</ul>
</ul>
<p>The old draft remains available but is unmaintained:</p>
<p>→ <a href="https://www.completenoobs.com/noobs/Main_Page" target="_blank">CompleteNoobs.com (old wiki)</a></p>
<p>→ <a href="https://xml.completenoobs.com" target="_blank">xml.CompleteNoobs.com (old xml downloads)</a></p>

<h2>n33b.com</h2>
<p class="status">Currently on hold.</p>
<p>It will <strong>not</strong> become a coin project. It will return to its original purpose: a purely educational site for people who like to learn by tinkering and hands-on experimentation.</p>

<h2>v4call.com</h2>
<p>→ <a href="https://v4call.com" target="_blank">v4call.com</a></p>
<p class="status">idk — tinker gonna tinker 😄</p>

<hr>
<p style="text-align:center; color:#777; font-size:0.9em;">
Last updated: April 2026
</p>

<script>
function acceptAndHide() {
// Save the choice in the browser's "localStorage" so it doesn't pop up again
localStorage.setItem('gate_passed', 'true');
document.getElementById('overlay').classList.add('hidden');
}

// On page load, check if they already clicked "Yes"
window.onload = function() {
if (localStorage.getItem('gate_passed') === 'true') {
document.getElementById('overlay').classList.add('hidden');
}
};
</script>

</body>
</html>
</pre>

V4CALL

2026-04-19T14:17:40Z

AwesomO: Created page with "{{:LICENCE_HEADER_MIT}} = v4call — Deploy Your Own Server on Ubuntu 24.04 with Docker = From CompleteNoobs This guide walks through deploying your own v4call server from scratch on a fresh Vultr Ubuntu 24.04 VPS — from first login to a working HTTPS video/audio calling service on your own domain. v4call is an open-source, decentralised video and audio calling platform that uses Hive blockchain for identity and HBD micropayments. It supports custom Hive-Engine to..."

{{:LICENCE_HEADER_MIT}}

= v4call — Deploy Your Own Server on Ubuntu 24.04 with Docker =

From CompleteNoobs

This guide walks through deploying your own v4call server from scratch on a fresh Vultr Ubuntu 24.04 VPS — from first login to a working HTTPS video/audio calling service on your own domain.

v4call is an open-source, decentralised video and audio calling platform that uses Hive blockchain for identity and HBD micropayments. It supports custom Hive-Engine token payments, encrypted direct messages with persistent chat history, voice-only and video calls, and a free-market platform fee system. Fork it, run your own server, keep all your platform fees, join the federation, federation coming (unknown time) kismet.

'''Source code''': [https://github.com/CompleteNoobs/v4call https://github.com/CompleteNoobs/v4call]

'''End result''': A working v4call server at <code>https://call.yourdomain.com</code> that you can log into with a Hive account.

== Contents ==

* [[#What_You_Need|1 What You Need]]
* [[#Step_1:_Create_Your_Vultr_VPS|2 Step 1: Create Your Vultr VPS]]
* [[#Step_2:_Point_Your_Domain_at_the_VPS|3 Step 2: Point Your Domain at the VPS]]
* [[#Step_3:_Log_into_Your_VPS|4 Step 3: Log into Your VPS]]
* [[#Step_4:_Update_the_Server|5 Step 4: Update the Server]]
* [[#Step_5:_Install_Docker|6 Step 5: Install Docker]]
* [[#Step_6:_Install_Git|7 Step 6: Install Git]]
* [[#Step_7:_Fork_and_Clone_the_Code|8 Step 7: Fork and Clone the Code]]
* [[#Step_8:_Configure_Your_Server_(.env_file)|9 Step 8: Configure Your Server (.env file)]]
* [[#Step_9:_Configure_Nginx_—_HTTP_Only_First|10 Step 9: Configure Nginx — HTTP Only First]]
* [[#Step_10:_Create_Data_Directories_and_Fix_Permissions|11 Step 10: Create Data Directories and Fix Permissions]]
* [[#Step_11:_Build_and_Start_the_Server|12 Step 11: Build and Start the Server]]
* [[#Step_12:_Get_Your_SSL_Certificate|13 Step 12: Get Your SSL Certificate]]
* [[#Step_13:_Enable_HTTPS_in_Nginx|14 Step 13: Enable HTTPS in Nginx]]
* [[#Step_14:_Set_Up_SSL_Auto-Renewal|15 Step 14: Set Up SSL Auto-Renewal]]
* [[#Step_15:_Test_Everything_is_Working|16 Step 15: Test Everything is Working]]
* [[#Step_16:_Set_Up_Your_Call_Rates_on_Hive|17 Step 16: Set Up Your Call Rates on Hive]]
* [[#Feature_Guide:_What_Your_Server_Can_Do|18 Feature Guide: What Your Server Can Do]]
* [[#Admin_Configuration_Reference|19 Admin Configuration Reference]]
* [[#Updating_Your_Server|20 Updating Your Server]]
* [[#Common_Problems_and_Fixes|21 Common Problems and Fixes]]
* [[#Quick_Reference|22 Quick Reference]]

== What You Need ==

Before starting, make sure you have the following:

* '''A Vultr account''' — sign up at [https://vultr.com vultr.com] - please use are [https://www.vultr.com/?ref=7704739 Vultr Referral link] to help us cover server costs.
* '''A domain name''' with DNS access — e.g. <code>call.yourdomain.com</code>
* '''Two Hive accounts''' — one for your server identity (receives platform fees), one for escrow (holds caller funds during calls). Create free accounts at [https://signup.hive.io signup.hive.io]
* '''Hive Keychain browser extension''' — for login and payments. Install from [https://hive-keychain.com hive-keychain.com]
* '''A GitHub account''' — free at [https://github.com github.com]. You will fork the v4call project.
* '''A terminal''' — Mac: Terminal app. Windows: PowerShell or PuTTY.

You do not need to know how to code. Every command can be copy-pasted exactly as shown.

== Step 1: Create Your Vultr VPS ==

# Log into [https://my.vultr.com my.vultr.com]
# Click '''Deploy New Server'''
# Choose '''Cloud Compute — Shared CPU'''
# Choose a location close to you
# Choose '''Ubuntu 24.04 LTS x64'''
# Choose the '''$6/month''' plan (1 CPU, 1GB RAM)
# Set Server Hostname to something like <code>v4call-server</code>
# Click '''Deploy Now'''

Wait ~60 seconds for it to start. Click the server to find:
* '''IP Address''' — looks like <code>123.456.789.012</code> — write it down
* '''Password''' — click the eye icon — write it down

== Step 2: Point Your Domain at the VPS ==

Log into your DNS provider and add an A record:

{| class="wikitable"
|-
! Field !! Value
|-
| Type || A
|-
| Name || <code>call</code> (or <code>@</code> for root domain)
|-
| Value || Your VPS IP address
|-
| TTL || 300
|}

DNS takes a few minutes to propagate. Check from your computer later:

nslookup call.yourdomain.com

Must show your VPS IP before Step 12. You can continue with all other steps while waiting.

== Step 3: Log into Your VPS ==

Open a terminal on your computer:

ssh root@YOUR_SERVER_IP

Type <code>yes</code> when asked about the fingerprint, then paste the password from Vultr (right-click to paste in most terminals).

When you see <code>root@v4call-server:~#</code> you are in.

== Step 4: Update the Server ==

apt update && apt upgrade -y

Wait for it to complete (1-2 minutes).

== Step 5: Install Docker ==

Install Docker using the official installer script:

curl -fsSL https://get.docker.com | sh

Verify:

docker --version

Should show <code>Docker version 26.x.x</code> or similar.

Install Docker Compose plugin:

apt install -y docker-compose-plugin

Verify:

docker compose version

Should show <code>Docker Compose version v2.x.x</code>.

== Step 6: Install Git ==

apt install -y git
git --version

== Step 7: Download and/or Fork and Clone the Code ==

=== Clone onto your VPS ===

cd /opt
git clone https://github.com/CompleteNoobs/v4call.git
cd v4call

==== Fork on GitHub - Optional ====

Forking gives you your own copy of the code that you can customise — change the name, branding, fees — without affecting the original project.

# Go to [https://github.com/CompleteNoobs/v4call https://github.com/CompleteNoobs/v4call]
# Click the '''Fork''' button (top right of the page)
# Select your GitHub account as the destination
# Click '''Create fork'''

You now have your own copy at <code>https://github.com/YOURUSERNAME/v4call</code>

==== Clone onto your VPS ====

cd /opt
git clone https://github.com/YOURUSERNAME/v4call.git
cd v4call

List the files to confirm:

ls

You should see: <code>server.js public/ Dockerfile docker-compose.yml nginx/ package.json .env.example</code>

== Step 8: Configure Your Server (.env file) ==

All settings live in a single <code>.env</code> file. Copy the template:

cp .env.example .env
nano .env

Fill in your values:

<pre>
# ── Server Identity ──────────────────────────────────────
SERVER_NAME=yourcallapp
SERVER_DOMAIN=call.yourdomain.com
SERVER_HIVE_ACCOUNT=yourhiveaccount
ESCROW_ACCOUNT=yourescrowaccount
V4CALL_ESCROW_KEY=5Kxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx
# Secret key to access /admin/ledger and /admin/balance endpoints.
# Choose a long random string — treat it like a password.
# Example: openssl rand -hex 32
ADMIN_KEY=make-up-a-long-random-string-at-least-20-characters

# ── Hive Blockchain ──────────────────────────────────────
CHAIN=hive
HIVE_API=

# ── Platform Fee ─────────────────────────────────────────
# Percentage your server takes from each paid call/DM (10 = 10%)
# This is the MINIMUM fee — users whose rates post sets a lower
# platform fee will be rejected. Users who set a higher fee
# get the best price (your server's rate, not their higher number).
DEFAULT_PLATFORM_FEE=10

# ── Network ──────────────────────────────────────────────
PORT=3000
BIND_HOST=127.0.0.1

# ── Chat Storage ─────────────────────────────────────────
# How many days to keep stored DMs before automatic cleanup
DM_RETENTION_DAYS=33
# How many days to keep stored room messages before cleanup
ROOM_RETENTION_DAYS=33
# How many recent DMs per conversation to show on login (0 = off)
DM_PREVIEW_COUNT=1

# ── Call Behaviour (advanced — defaults are fine) ────────
# CALL_COOLDOWN_MS=30000
# MAX_CALL_DURATION_MIN=120
# PAYMENT_VERIFY_RETRIES=3
# PAYMENT_VERIFY_DELAY_MS=5000
</pre>

Key points:

* <code>V4CALL_ESCROW_KEY</code> — must be the '''active''' private key for your escrow account. Find it in your Hive wallet → Keys & Permissions → Active. Starts with <code>5K</code>. '''Never share this.'''
* <code>ADMIN_KEY</code> — invent a secret password for accessing admin tools
* <code>HIVE_API</code> — leave blank to use all built-in Hive nodes automatically
* <code>DEFAULT_PLATFORM_FEE</code> — your server's minimum platform fee percentage. See [[#Platform_Fee_System|Platform Fee System]] below for how this works.
* <code>DM_RETENTION_DAYS</code> / <code>ROOM_RETENTION_DAYS</code> — how long chat messages are kept in the database. A cleanup job runs every hour and deletes anything older. Set to <code>0</code> to keep messages indefinitely (not recommended).
* <code>DM_PREVIEW_COUNT</code> — when a user logs in, this many recent DMs per conversation are loaded into the lobby chat so they can see previews. Set to <code>0</code> to disable previews (users still get an unread count alert).

Save: '''Ctrl+X''' → '''Y''' → '''Enter'''

== Step 9: Configure Nginx — HTTP Only First ==

'''This step is critical.''' A very common mistake is putting the HTTPS/SSL config in Nginx before getting the certificate. Nginx tries to load the certificate at startup — if the file doesn't exist yet, Nginx crashes in a restart loop. Certbot then cannot serve the challenge because Nginx is down. Result: no certificate, stuck in a loop.

The fix: always start with HTTP only, get the certificate, then add HTTPS.

Edit the Nginx config:

nano /opt/v4call/nginx/v4call.conf

Delete everything and replace with this HTTP-only config:

<pre>
server {
listen 80;
server_name call.yourdomain.com www.call.yourdomain.com;

# Certbot challenge path — do not remove this block
location /.well-known/acme-challenge/ {
root /var/www/certbot;
}

# Proxy all other requests to the v4call app
location / {
proxy_pass http://app:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_read_timeout 86400;
}
}
</pre>

Replace <code>call.yourdomain.com</code> with your actual domain in both places.

Save: '''Ctrl+X''' → '''Y''' → '''Enter'''

== Step 10: Create Data Directories and Fix Permissions ==

Create the folders Docker uses for persistent data:

mkdir -p /opt/v4call/data/logs \
mkdir -p /opt/v4call/data/certbot/conf \
mkdir -p /opt/v4call/data/certbot/www/.well-known/acme-challenge \
mkdir -p /opt/v4call/data/certbot/logs

'''Fix permissions — do not skip this.'''

The v4call app runs inside Docker as user <code>node</code> (UID 1000). On the host, these directories are created by root, so the container cannot write to them. This causes a <code>SQLITE_CANTOPEN</code> error that crashes the app.

Fix the logs directory for the app:

chown -R 1000:1000 /opt/v4call/data/logs

Certbot runs as root so its directories stay root-owned:

chown -R root:root /opt/v4call/data/certbot
chmod -R 755 /opt/v4call/data/certbot

'''Note:''' The app creates two separate SQLite databases in the logs directory:
* <code>v4call-ledger.db</code> — payment records (calls, ring fees, payouts). Only the server writes to this.
* <code>v4call-chat.db</code> — stored DMs and room messages. Separate from the ledger for security — if a bug in chat storage were exploited, the payment ledger remains untouched.

== Step 11: Build and Start the Server ==

cd /opt/v4call
docker compose up -d --build

The first build downloads dependencies and takes 2-4 minutes. Check the status:

docker compose ps

You should see:

<pre>
NAME STATUS
v4call-app Up (healthy)
v4call-nginx Up
</pre>

Check the app started correctly:

docker compose logs app

Look for:

<pre>
[ledger] SQLite ready: /app/logs/v4call-ledger.db
[chat] SQLite ready: /app/logs/v4call-chat.db
v4call server running on 0.0.0.0:3000
[config] Server: yourcallapp (call.yourdomain.com)
[config] DM retention: 33 days | Room retention: 33 days | DM preview: 1
✓ Escrow key verified — matches @yourescrowaccount active key
✓ Escrow account @yourescrowaccount balance: 0.000 HBD
</pre>

If you see <code>SqliteError: unable to open database file</code> — run the chown command from Step 10 again then <code>docker compose restart app</code>.

Test HTTP is working:

curl http://call.yourdomain.com/debug-state

Should return: <code>{"lobbyUsers":[],"rooms":[]}</code>

If you can see the site in a browser over HTTP at this point — everything is working and ready for the certificate.

== Step 12: Get Your SSL Certificate ==

'''Before running certbot''', verify DNS and the challenge path are both working:

# Check DNS points to this server
nslookup call.yourdomain.com

# Test the challenge path
echo "test" > /opt/v4call/data/certbot/www/.well-known/acme-challenge/testfile
curl http://call.yourdomain.com/.well-known/acme-challenge/testfile

The curl command must return <code>test</code>. If it does not, Nginx is not running — check <code>docker compose ps</code> and <code>docker compose logs nginx</code>.

When both work, get the certificate. The <code>--entrypoint certbot</code> flag is required — without it, Docker runs the container's default renewal loop instead of the certonly command:

docker compose run --rm \
--entrypoint certbot \
certbot certonly \
--webroot \
-w /var/www/certbot \
-d call.yourdomain.com \
--email your@email.com \
--agree-tos \
--no-eff-email

Replace <code>call.yourdomain.com</code> with your domain and <code>your@email.com</code> with your email.

Success looks like:

<pre>
Requesting a certificate for call.yourdomain.com

Successfully received certificate.
Certificate is saved at: /etc/letsencrypt/live/call.yourdomain.com/fullchain.pem
Key is saved at: /etc/letsencrypt/live/call.yourdomain.com/privkey.pem
This certificate expires on 2026-07-09.
</pre>

Verify the files exist on the host:

ls /opt/v4call/data/certbot/conf/live/call.yourdomain.com/

Should show: <code>cert.pem chain.pem fullchain.pem privkey.pem README</code>

== Step 13: Enable HTTPS in Nginx ==

Now the certificate exists, update Nginx to serve HTTPS.

nano /opt/v4call/nginx/v4call.conf

Replace everything with the full HTTPS config:

<pre>
# HTTP — only used for certbot challenge and redirect to HTTPS
server {
listen 80;
server_name v4call.com v4call.com;

location /.well-known/acme-challenge/ {
root /var/www/certbot;
}

location / {
return 301 https://$host$request_uri;
}
}

# HTTPS — auth lives here
server {
listen 443 ssl;
server_name v4call.com v4call.com;
# CHANGE PATH: for ssl certifcates change v4call.com to your path: which you can find at "ls data/certbot/conf/live/"
ssl_certificate /etc/letsencrypt/live/v4call.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/v4call.com/privkey.pem;

ssl_protocols TLSv1.2 TLSv1.3;
ssl_prefer_server_ciphers off;

add_header Strict-Transport-Security "max-age=63072000" always;
add_header X-Frame-Options DENY;
add_header X-Content-Type-Options nosniff;

# When user cancels the login prompt, send them here
error_page 401 /info.html;

# info.html is served directly by Nginx — no auth, no proxy
location = /info.html {
root /usr/share/nginx/html;
auth_basic off;
}

# WebSocket — requires auth
location /socket.io/ {
# uncomment to require username and password to enter site - useful for testing
# auth_basic "v4call — Private Testing";
# auth_basic_user_file /etc/nginx/.htpasswd;

proxy_pass http://app:3000;
proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection "upgrade";
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_cache_bypass $http_upgrade;
proxy_read_timeout 86400;
}

# Everything else — requires auth, proxied to app
location / {
# uncomment to require username and password to enter site - useful for testing
# auth_basic "v4call — Private Testing";
# auth_basic_user_file /etc/nginx/.htpasswd;

proxy_pass http://app:3000;
proxy_http_version 1.1;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_read_timeout 300;
proxy_send_timeout 300;
}
# This will log correct and incorrect attempts logging in, if .htpasswd used
error_log /var/log/nginx/error.log warn;
access_log /var/log/nginx/access.log;
}
</pre>

* REPLACE <code>call.yourdomain.com</code> with your domain throughout (it appears 5 times).
* CHANGE PATH: for ssl certifcates change v4call.com to your path: which you can find at <code>ls data/certbot/conf/live/</code> if not sure.
<pre>
ssl_certificate /etc/letsencrypt/live/v4call.com/fullchain.pem;
ssl_certificate_key /etc/letsencrypt/live/v4call.com/privkey.pem;
</pre>

Save and restart Nginx:

docker compose restart nginx

Check the logs — you should see '''no''' <code>[emerg]</code> errors:

docker compose logs nginx

The last lines should show:

<pre>
nginx/1.x.x ...
start worker processes
</pre>

* If you see an error such as:
<pre>[emerg] 1#1: cannot load certificate "/etc/letsencrypt/live/call.yourdomain.com/fullchain.pem": BIO_new_file() failed (SSL: error:80000002:system library::No such file or directory:calling fopen(/etc/letsencrypt/live/call.yourdomain.com/fullchain.pem, r) error:10000080:BIO routines::no such file)</pre>

* Make sure you edited <code>nginx/v4call.conf</code> correctly.
* To find the path for your SSL certs look in path <code>data/certbot/conf/live/</code>
* There are 4 lines to check in <code>nginx/v4call.conf</code>:
** Line 4: <code>server_name call.yourdomain.com www.call.yourdomain.com;</code>
** Line 18: <code>server_name call.yourdomain.com www.call.yourdomain.com;</code>
** Line 20: <code>ssl_certificate /etc/letsencrypt/live/call.yourdomain.com/fullchain.pem;</code>
** Line 21: <code>ssl_certificate_key /etc/letsencrypt/live/call.yourdomain.com/privkey.pem;</code>
* When done restart nginx with: <code>docker compose restart nginx</code>

== Step 14: Set Up SSL Auto-Renewal ==

Let's Encrypt certificates expire after 90 days. A cron job renews them automatically.

crontab -e

Add this line at the bottom:

0 3 * * * cd /opt/v4call && docker compose run --rm --entrypoint certbot certbot renew --quiet && docker compose exec nginx nginx -s reload

Save and exit. This runs at 3am every day, renews if the cert is close to expiry, and reloads Nginx to pick up the new certificate.

== Step 15: Test Everything is Working ==

Test HTTPS:

curl https://call.yourdomain.com/debug-state

Should return: <code>{"lobbyUsers":[],"rooms":[]}</code>

Test admin access:

curl "https://call.yourdomain.com/admin/balance?key=YOUR_ADMIN_KEY"

Should return your escrow account balance.

Open your browser and go to <code>https://call.yourdomain.com</code>

You should see the v4call login page with:
* A padlock icon in the browser address bar
* A green '''⚡ Sign in with Keychain''' button (if Hive Keychain is installed)
* A manual posting key login option below it
* A '''📖 New here? Learn the v4call basics →''' link at the bottom

Log in with Hive Keychain or a posting key to confirm the login flow works. 🎉

== Step 16: Set Up Your Call Rates on Hive ==

For callers to be charged when they ring you, publish your rates on the Hive blockchain:

# Make sure Hive Keychain is installed in your browser
# Go to <code>https://call.yourdomain.com/rate-editor.html</code>
# Enter your Hive username
# Set your rates — ring fee, connect fee, duration rate per hour, minimum credit deposit
# Set <code>PLATFORM-FEE</code> to at least your server's <code>DEFAULT_PLATFORM_FEE</code> percentage (e.g. <code>10</code> for 10%). If you set it lower, paid contacts to your account will be rejected on this server.
# Optionally add custom token sections (e.g. <code>[TOKEN:CNOOBS]</code>) to offer discounted rates for callers who hold your token
# Click '''Generate''' to preview the rates block
# Click '''Post to Hive''' — Keychain will ask you to approve the post

This creates a post titled <code>v4call-rates</code> on your Hive blog. Your server reads this post automatically.

To verify your server read the rates correctly:

https://call.yourdomain.com/debug-rates/yourusername

To test with a specific caller (checks their token balances too):

https://call.yourdomain.com/debug-rates/yourusername?caller=theirusername&type=voice

You should see your rates as JSON, including which currency and rates apply for that caller.

== Feature Guide: What Your Server Can Do ==

This section explains all the features available in v4call and how they work. No code changes needed — everything described here is built in and ready to use.

=== Login Options ===

v4call supports two ways to sign in:

* '''Hive Keychain''' (recommended) — click the green '''⚡ Sign in with Keychain''' button. Keychain signs a challenge to prove your identity. No key paste needed. After login, a 🔑 panel appears in the lobby where you can optionally enter your posting key to unlock encrypted messaging (Keychain cannot expose private keys, so encryption needs the key entered once per session).
* '''Manual posting key''' — paste your Hive posting private key (starts with <code>5J</code>) directly. The key stays in browser session memory only — never sent to the server.

Both methods verify your identity against the Hive blockchain.

=== Voice and Video Calls ===

Each online user in the lobby shows three action buttons:

* '''📞 Green phone icon''' — start a '''voice-only''' call (audio, no camera)
* '''🎥 Blue camera icon''' — start a '''video''' call (audio + camera)
* '''💬 Purple chat bubble icon''' — open the '''DM panel''' to send a direct message

Voice calls request microphone only — no camera permission prompt. Video calls request both. The caller and callee can have different call types — the type is set by whoever initiates the call.

Separate rates can be set for voice and video calls in the rates post (voice is typically cheaper).

=== Direct Messages (DMs) ===

Click the purple 💬 button next to any online user to open the DM panel. DMs are end-to-end encrypted using Hive posting keys — the server stores only ciphertext it cannot read.

'''Chat storage:''' DMs are stored on the server in an encrypted database (<code>v4call-chat.db</code>) for up to <code>DM_RETENTION_DAYS</code> (default: 33 days). Both sender and recipient get their own encrypted copy stored, so both can retrieve their history later.

'''Unread alerts:''' When you log in, if you have unread DMs, a popup appears showing how many messages from how many users. Click a username in the popup to open their DM history.

'''DM previews:''' The last <code>DM_PREVIEW_COUNT</code> messages per conversation are loaded into the lobby chat on login, so you can see recent activity at a glance. Set to <code>0</code> in <code>.env</code> to disable.

'''Full history:''' Click the DM button for any user to load the complete conversation history, shown between "— DM history —" dividers.

=== Rooms ===

Users can create private rooms by selecting users in the lobby (toggle switch) and clicking '''Create & Invite'''. Rooms support encrypted messaging, video, and voice.

'''Room history:''' When a new user joins a room, they see past messages — broadcasts in full, encrypted messages only if they were addressed to them. A "— earlier messages —" divider separates history from live messages.

'''Ephemeral rooms:''' A warning banner at the top of every room says: "⚠ Room is ephemeral — if all users leave, the room and its history are deleted. New members can only read messages encrypted to their key." When the last person leaves a room, all stored messages for that room are deleted from the database.

=== Custom Token Payments (Hive-Engine) ===

v4call supports payment in any Hive-Engine token, not just HBD. This is configured per-user in their rates post using <code>[TOKEN:SYMBOL]</code> sections.

'''How it works:'''
# A user (e.g. @cnoobz) creates a custom token on Hive-Engine (e.g. CNOOBS)
# In their rates post, they add a <code>[TOKEN:CNOOBS]</code> section with lower rates than their default HBD rates
# When a caller who holds CNOOBS contacts @cnoobz, the server detects the token balance and offers the token rates
# If the caller holds multiple qualifying tokens, '''all options are shown''' in a currency picker — the caller chooses which to pay with
# The payment goes through Hive Keychain as a <code>custom_json</code> Hive-Engine transfer

'''For the escrow account:''' Your escrow account needs to hold some of each custom token that users on your server accept. Token payouts (to the callee) and refunds (to the caller) are sent from the escrow account's token balance, just like HBD.

'''Payment picker:''' When multiple payment options exist (e.g. CNOOBS at 1 per message, HBD at 100000 per message), the payment modal shows clickable currency buttons so the caller can see all rates and choose the best option.

=== Platform Fee System ===

The platform fee is how your server earns revenue from paid calls and DMs.

'''How it works:'''
* Your server's <code>DEFAULT_PLATFORM_FEE</code> in <code>.env</code> is the '''minimum''' percentage your server accepts (e.g. <code>10</code> = 10%)
* Each user sets <code>PLATFORM-FEE</code> in their Hive rates post — this is the maximum fee they are willing to pay to a server
* If the user's posted fee is '''lower''' than your server's minimum → '''rejected'''. The caller sees a message explaining the mismatch, and the callee is told to raise their fee.
* If the user's posted fee '''meets or exceeds''' your server's minimum → '''accepted''', and '''the server charges its own rate''' (the minimum), not the user's higher number. The callee gets the best price.
* If the user has '''no <code>PLATFORM-FEE</code> line''' in their rates post → the server's default is used automatically. No mismatch.
* '''Free contacts''' (no payment involved) are never affected by fee enforcement.

'''Why this matters for federation:''' Different servers can set different platform fees. Users can shop around — pick a server with a fee they find agreeable. This creates a free market for server operators.

'''Example:'''
* Your server: <code>DEFAULT_PLATFORM_FEE=3</code> (3%)
* @alice posts: <code>PLATFORM-FEE: 5%</code> → accepted, server charges 3% (best price for alice)
* @bob posts: <code>PLATFORM-FEE: 1%</code> → rejected, bob needs to raise to at least 3%
* @charlie has no fee line → defaults to 3%, automatically accepted

== Admin Configuration Reference ==

All settings are in the <code>.env</code> file. After changing any value, rebuild:

docker compose down && docker compose build --no-cache && docker compose up -d

{| class="wikitable"
|-
! Variable !! Default !! Description
|-
| <code>SERVER_NAME</code> || <code>v4call</code> || Display name for your server
|-
| <code>SERVER_DOMAIN</code> || <code>v4call.com</code> || Your server's domain
|-
| <code>SERVER_HIVE_ACCOUNT</code> || <code>v4call</code> || Hive account that receives platform fees
|-
| <code>ESCROW_ACCOUNT</code> || <code>v4call-escrow</code> || Hive account that holds funds during calls
|-
| <code>V4CALL_ESCROW_KEY</code> || ''(none)'' || Active private key for the escrow account. '''Required.'''
|-
| <code>ADMIN_KEY</code> || ''(none)'' || Password for admin endpoints (<code>/admin/balance</code>, <code>/admin/ledger</code>)
|-
| <code>DEFAULT_PLATFORM_FEE</code> || <code>10</code> || Server's minimum platform fee percentage
|-
| <code>DM_RETENTION_DAYS</code> || <code>33</code> || Days to keep stored DMs before cleanup
|-
| <code>ROOM_RETENTION_DAYS</code> || <code>33</code> || Days to keep stored room messages before cleanup
|-
| <code>DM_PREVIEW_COUNT</code> || <code>1</code> || Recent DMs per conversation shown on login (0 = off)
|-
| <code>HIVE_API</code> || ''(blank)'' || Override primary Hive API node. Blank = auto-select from built-in list
|-
| <code>MAX_CALL_DURATION_MIN</code> || <code>120</code> || Maximum call length in minutes before auto-disconnect
|-
| <code>CALL_COOLDOWN_MS</code> || <code>30000</code> || Milliseconds between call attempts to same user
|-
| <code>PAYMENT_VERIFY_RETRIES</code> || <code>3</code> || Number of attempts to verify a blockchain payment
|-
| <code>PAYMENT_VERIFY_DELAY_MS</code> || <code>5000</code> || Delay between verification retry attempts
|}

=== Debug Endpoints ===

These are useful for testing without making actual calls:

* <code>/debug-state</code> — shows current lobby users and active rooms (no auth required)
* <code>/debug-rates/USERNAME</code> — shows parsed rates for a user
* <code>/debug-rates/USERNAME?caller=CALLER&type=voice</code> — shows what rates a specific caller would receive (checks token balances too)
* <code>/admin/balance?key=YOUR_ADMIN_KEY</code> — shows escrow account HBD balance
* <code>/admin/ledger?key=YOUR_ADMIN_KEY</code> — shows recent payment records

== Updating Your Server ==

'''Important:''' Always use <code>docker compose down</code> before rebuilding. Without this step, Docker may reuse the old container even after a rebuild, and your changes will not take effect.

cd /opt/v4call
docker compose down
docker compose build --no-cache
docker compose up -d

Your data, SQLite databases and <code>.env</code> config are preserved — they live in <code>data/logs/</code> which is a mounted volume.

To pull updates from GitHub and deploy:

cd /opt/v4call
git pull
docker compose down
docker compose build --no-cache
docker compose up -d

To push your own customisations to GitHub:

# On your local computer after making changes:
git add .
git commit -m "describe what you changed"
git push

# On the VPS:
cd /opt/v4call
git pull
docker compose down
docker compose build --no-cache
docker compose up -d

== Common Problems and Fixes ==

=== Changes not showing after rebuild ===

If you edited <code>server.js</code> or <code>index.html</code> but changes are not visible, you probably forgot to bring Docker down first. <code>docker compose restart</code> and even <code>docker compose up -d --build</code> can reuse old containers.

'''Fix:'''

docker compose down
docker compose build --no-cache
docker compose up -d

=== SqliteError: unable to open database file ===

The app container runs as UID 1000 but the logs directory was created by root. Fix:

chown -R 1000:1000 /opt/v4call/data/logs
docker compose restart app

=== Certbot says "No renewals were attempted" ===

The certbot container's default behaviour is a renewal loop. Your <code>certonly</code> command is being ignored. Always use <code>--entrypoint certbot</code> to override it:

docker compose run --rm --entrypoint certbot certbot certonly ...

Without <code>--entrypoint certbot</code> the container runs its renewal script instead of your command.

=== Nginx crashes with "cannot load certificate: No such file" ===

You added the HTTPS server block before getting the certificate. Nginx reads all server blocks at startup — if the cert file doesn't exist, the entire process fails.

Fix: revert nginx config to HTTP-only (Step 9), restart Nginx, get the certificate (Step 12), then re-add HTTPS (Step 13).

=== Webroot challenge test returns nothing ===

Nginx is not running. Check:

docker compose ps
docker compose logs nginx

If Nginx is restarting — it has the HTTPS config with a missing cert file. Use the HTTP-only config.

=== "Escrow key does NOT match" warning on startup ===

The key in <code>.env</code> is the wrong type. You need the '''active''' private key, not the posting or owner key. Find it in your Hive wallet → Keys & Permissions → Active. It starts with <code>5K</code>.

=== Site unreachable on port 443 ===

Check that the certificate was issued:

ls /opt/v4call/data/certbot/conf/live/

Should show a folder with your domain name. If empty — go back to Step 12.

=== npm ci error during Docker build ===

The <code>npm ci</code> command requires a <code>package-lock.json</code> file. The project uses <code>npm install</code> instead. If you see this error, check your <code>Dockerfile</code> — it should say <code>npm install</code> not <code>npm ci</code>.

=== Custom token payments not working ===

If token rates are detected but payments fail:
* Check the escrow account holds the token — send some tokens to your escrow account on Hive-Engine
* Check the token symbol matches exactly (case-sensitive) between the rates post and Hive-Engine
* Check the server logs: <code>docker compose logs app | grep -i "token\|cnoobs\|escrow-token"</code>
* The Hive-Engine API endpoint must be <code>https://api.hive-engine.com/rpc/contracts</code> — this is built into the code

=== [encrypted — unlock with 🔑 key panel to read] ===

You logged in with Hive Keychain. Keychain does not expose private keys, so encrypted messages cannot be decrypted without your posting key. Enter your posting key in the 🔑 panel at the bottom of the online users list. The key stays in browser session memory only — it is needed once per session.

== Quick Reference ==

{| class="wikitable"
|-
! Command !! What it does
|-
| <code>docker compose ps</code> || Show status of all containers
|-
| <code>docker compose logs app</code> || Show app logs
|-
| <code>docker compose logs nginx</code> || Show Nginx logs
|-
| <code>docker compose logs -f app</code> || Watch live logs (Ctrl+C to stop)
|-
| <code>docker compose down</code> || Stop everything ('''always do this before rebuilding''')
|-
| <code>docker compose build --no-cache</code> || Rebuild without using cached layers
|-
| <code>docker compose up -d</code> || Start everything in background
|-
| <code>docker compose down && docker compose build --no-cache && docker compose up -d</code> || Full rebuild cycle (use after any code change)
|-
| <code>docker compose restart nginx</code> || Restart Nginx after config-only changes (no rebuild needed)
|-
| <code>chown -R 1000:1000 /opt/v4call/data/logs</code> || Fix SQLite write permissions
|-
| <code>docker compose run --rm --entrypoint certbot certbot certificates</code> || List SSL certificates
|-
| <code>curl http://yourdomain.com/.well-known/acme-challenge/testfile</code> || Test certbot webroot works
|-
| <code>docker compose logs app | grep -i "token\|escrow"</code> || Check token payment logs
|}

== Optional: Password Protect Your Server During Testing ==

<div class="toccolours mw-collapsible mw-collapsed">
<strong>Optional: Password Protect Your Server During Testing (HTTP Basic Auth)</strong>
<div class="mw-collapsible-content">

During development and testing you may want to restrict access so only people you invite can use your server. This uses Nginx HTTP Basic Auth — a simple username and password prompt that appears before the v4call login screen.

When a visitor cancels the login prompt they are shown a public <code>info.html</code> page where they can read about the project and request access.

*<b> Step 1 — Install the htpasswd tool</b>

<code>apt install -y apache2-utils</code>

*<b> Step 2 — Create the password file and add your first user </b>

<code>htpasswd -c /opt/v4call/nginx/.htpasswd yourusername</code>

You will be prompted to enter and confirm a password. The <code>-c</code> flag creates the file. Do not use <code>-c</code> again or it will overwrite the file and delete existing users.

To add more users later:

<code>htpasswd /opt/v4call/nginx/.htpasswd anotherusername</code>

To remove a user:

<code>htpasswd -D /opt/v4call/nginx/.htpasswd username</code>

*<b> Step 3 — Create the public info page </b>

<code>nano /opt/v4call/public/info.html</code>

Paste your HTML content — a page explaining the project and how to request access. This page is served publicly without a password so visitors who cancel the login prompt can still read it.

*<b> Step 4 — Mount the files into the Nginx container </b>

Edit <code>docker-compose.yml</code> and add two lines to the nginx volumes section:

<pre>
nginx:
volumes:
- ./nginx/v4call.conf:/etc/nginx/conf.d/default.conf:ro
- ./nginx/.htpasswd:/etc/nginx/.htpasswd:ro # add this
- ./public/info.html:/usr/share/nginx/html/info.html:ro # add this
- ./data/certbot/conf:/etc/letsencrypt:ro
- ./data/certbot/www:/var/www/certbot:ro
</pre>

*<b> Step 5 — Update your Nginx config </b>

Add auth to the '''HTTPS server block''' (not the HTTP block — users are redirected to HTTPS so auth must live there). Add these lines to both the <code>/socket.io/</code> and <code>/</code> location blocks, and add the <code>error_page</code> and <code>info.html</code> location blocks:

<pre>
server {
listen 443 ssl;
server_name call.yourdomain.com www.call.yourdomain.com;

# ... ssl_certificate lines stay the same ...

# Send cancelled logins to the public info page
error_page 401 /info.html;

# info.html is served by Nginx directly — no auth, no proxy
location = /info.html {
root /usr/share/nginx/html;
auth_basic off;
}

# WebSocket — requires auth
location /socket.io/ {
auth_basic "v4call — Private Testing";
auth_basic_user_file /etc/nginx/.htpasswd;
proxy_pass http://app:3000;
# ... rest of proxy headers stay the same ...
}

# All other requests — requires auth
location / {
auth_basic "v4call — Private Testing";
auth_basic_user_file /etc/nginx/.htpasswd;
proxy_pass http://app:3000;
# ... rest of proxy headers stay the same ...
}
}
</pre>
* Note: if you want to log successful and unsuccessful login attempts, add:
<pre>
error_log /var/log/nginx/error.log warn;
access_log /var/log/nginx/access.log;
</pre>

*<b> Step 6 — Recreate the Nginx container to pick up the new volume mounts </b>

'''Important''': <code>docker compose restart nginx</code> is not enough — it reuses the old container and ignores new volume mounts. You must recreate it:

<code>docker compose down && docker compose up -d</code>

After this, verify the files are mounted inside the container:

<code>docker compose exec nginx ls /usr/share/nginx/html/</code>

You should see <code>info.html</code> listed alongside <code>50x.html</code> and <code>index.html</code>.

*<b> Step 7 — Test it works </b>

<code>curl -o /dev/null -s -w "%{http_code}" https://call.yourdomain.com/</code>

Should return <code>401</code> (login required).

<code>curl -o /dev/null -s -w "%{http_code}" https://call.yourdomain.com/info.html</code>

Should return <code>200</code> (public, no auth needed).

<code>curl -u youruser:yourpassword -o /dev/null -s -w "%{http_code}" https://call.yourdomain.com/</code>

Should return <code>200</code> (correct credentials accepted).

*<b> Managing users without restarting </b>

After adding or removing users from the <code>.htpasswd</code> file, reload Nginx config without downtime:

<code>docker compose exec nginx nginx -s reload</code>

No restart needed — Nginx re-reads the <code>.htpasswd</code> file on every request anyway.

*<b> Keep .htpasswd out of GitHub </b>

The password file should never be committed to your repository. Add it to <code>.gitignore</code>:

<code>echo "nginx/.htpasswd" >> /opt/v4call/.gitignore</code>

*<b> Removing auth when you go public </b>

When you are ready to open your server to everyone, simply remove the <code>auth_basic</code> lines from <code>nginx/v4call.conf</code> and reload:

<code>docker compose exec nginx nginx -s reload</code>

No other changes needed.

</div>
</div>

<div class="toccolours mw-collapsible mw-collapsed">
'''How to check if anyone tried to log in (failed attempts) or successfully logged in with .htpasswd on Nginx in Docker'''

<div class="mw-collapsible-content">

'''Important Tip:''' Always run these commands in the same folder where your <code>docker-compose.yml</code> file is located. If you are in the wrong directory the commands will not find your container and nothing will show up.

* ''''' Basic Commands '''''

; '''See everything live (good while testing)'''
: <code>docker compose logs -f nginx</code><br>
: <code>-f</code> means "follow/live" – new log lines appear automatically. Remove <code>-f</code> if you only want to read the current logs once and stop.

; '''Best command to watch failed login attempts (people guessing passwords)'''
: <code>docker compose logs -f nginx | grep -E "mismatch|not found|401"</code>

; '''See who successfully logged in'''
: <code>docker compose logs nginx | grep "remote_user"</code>

; '''Combined view – most useful for daily checking (failed + successful)'''
: <code>docker compose logs -f --tail=100 nginx | grep -E "(mismatch|not found|remote_user|401)"</code>

* ''''' What the Logs Look Like '''''

'''Failed attempt (wrong password):'''
<pre>2026/04/17 01:23:45 [error] ... user "admin": password mismatch, client: 185.123.45.67, ...</pre>

'''Failed attempt (wrong username):'''
<pre>2026/04/17 01:24:12 [error] ... user "hacker123" was not found in "/etc/nginx/.htpasswd", client: 45.67.89.10, ...</pre>

'''Successful login:'''
<pre>... "GET /protected/ HTTP/1.1" 200 ... remote_user: "myuser" ...</pre>

* ''''' How to Customise These Commands '''''

* Change <code>nginx</code> to the exact name of your service if it is different in docker-compose.yml.
* Remove <code>-f</code> to read the full log once without live following.
* Change <code>--tail=100</code> to <code>--tail=500</code> (or any number) to show more or fewer old lines.
* Add or remove words in the <code>grep</code> part to filter differently.
Examples:
* Only failed attempts: <code>grep -E "mismatch|not found"</code>
* Only 401 errors: <code>grep " 401 "</code>
* Everything auth related: <code>grep -E "(auth|password|mismatch|not found|remote_user)"</code>

* '''''Quick Copy-Paste Commands '''''

# Watch failed guesses live
docker compose logs -f nginx | grep -E "mismatch|not found|401"

# Check successful logins
docker compose logs nginx | grep "remote_user"

# Combined quick check (recommended)
docker compose logs -f --tail=100 nginx | grep -E "(mismatch|not found|remote_user|401)"

</div>
</div>

[[Category:Docker]]
[[Category:Ubuntu]]
[[Category:Hive]]
[[Category:v4call]]
[[Category:WebRTC]]

Main Page

2026-04-19T14:16:23Z

AwesomO: /* Licenses */

=In Concept development Mode - a wiki you can download=
= CompleteNoobs: A Downloadable Wiki for Reproducible Computer Tutorials =

'''CompleteNoobs''' is a open-source wiki offering free, reproducible computer science tutorials.

* [[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.]]

== About CompleteNoobs ==

Our mission is to provide accessible, libre-licensed resources for hobbyists, sysadmins, students, teachers, and computer science enthusiasts. All content is available under a '''Creative Commons BY-NC-SA''' license, ensuring the freedoms to:
* Read
* Edit/Modify
* Copy
* Share freely

Download the wiki as an XML file at [https://xml.completenoobs.com xml.completenoobs.com] or access data-heavy content (images, videos, audio) via '''IPFS''' hashes.

== Get Started ==

* '''Download the Wiki''': Run CompleteNoobs locally using our [[Local_CompleteNoobs_Wiki|Manually install guides or Docker image]].
* '''Host Your Own''': Set up your own MediaWiki instance with our guide: [[Host_Your_Own_Mediawiki_Online|Host Your Own MediaWiki Online]].

== CompleteNoobs Blockchain Project ==

As Noobs we want to learn more about bitcoin, without losing any real bitcoin

First we are learning how to fork bitcoin version 0.14.3, best way to learn is by tinkering with it.
* [[N33Bcoin| n33b.com]]

== Essential Links ==

* [[Main_Index|Main Index Page]]
* [[Special:AllPages|All Pages]]
* [[Wiki_Basic_Syntax|Wiki Basic Syntax]]
* [[COMPLETENOOBS_FUNDING|Support Us]]

== Licenses ==
[[LICENCE_HEADERS]]
All content is libre-licensed for free copying, modification, and distribution. Add a license header to your contributions using:
<pre>{{:LICENCE_HEADER_CC0}}</pre>
{{:LICENCE_HEADER_CC0}}

== Disclaimer ==

<div class="toccolours mw-collapsible mw-collapsed">
'''''DISCLAIMER:'''''
<div class="mw-collapsible-content">
Content on CompleteNoobs is for informational and educational purposes only. We make no warranties about accuracy or reliability. Use at your own risk. Links to external sites are not endorsements, and we are not responsible for their content or availability. The site may be temporarily unavailable due to technical issues beyond our control.
</div>
</div>

{{Special:ContributionScores/10/5}}
{{Special:PopularPages/10}}

Hive Blockchain - How to change Active and Posting keys on Hive

2026-04-19T13:57:14Z

AwesomO: Created page with "'''How to Change Your Active and Posting Keys on Hive (2026)''' To update your Active, Posting (or any) keys on Hive, you must perform a full **password reset**. This generates a new '''Master Password''' that automatically creates a fresh set of all keys (Owner, Active, Posting, Memo). =='''Critical Warnings'''== * If you lose the new Master Password or Owner Key, '''no one''' (not even Hive support) can recover your account. * '''Backup everything''' (especially the..."

'''How to Change Your Active and Posting Keys on Hive (2026)'''

To update your Active, Posting (or any) keys on Hive, you must perform a full **password reset**. This generates a new '''Master Password''' that automatically creates a fresh set of all keys (Owner, Active, Posting, Memo).

=='''Critical Warnings'''==
* If you lose the new Master Password or Owner Key, '''no one''' (not even Hive support) can recover your account.
* '''Backup everything''' (especially the new Master Password and all private keys) before clicking Update.
* You will need to manually add the new keys to Hive Keychain and other apps afterward.

=='''Method 1: Official Hive Wallet (wallet.hive.blog)'''==
# Go to [https://wallet.hive.blog wallet.hive.blog] (or directly to <code>https://wallet.hive.blog/@yourusername/permissions</code>).
# Log in using your current '''Owner Key''' or '''Master Password'''.
# Navigate to the '''Change Password''' section.
# Click '''"Click to Generate Password"'''.
# '''Save everything''': Copy the new Master Password and all displayed private/public keys. Store them securely offline.
# Re-enter the new Master Password in the confirmation field.
# Check all confirmation boxes.
# Click '''Update Password'''.

=='''Method 2: Using PeakD (often easier)'''==
# Log in to [https://peakd.com peakd.com] (usually via Hive Keychain).
# Go to your profile → '''Wallet''' → '''Keys & Permissions'''.
# Click the '''Change Password''' button.
# Authorize with your current '''Owner Key'''.
# Generate the new password, download/save all keys, then confirm the update.

=='''After Updating'''==
* Update Hive Keychain (remove old keys and import the new ones).
* Update any mobile apps (Ecency, Hive Wallet, etc.).
* Test logging in with the new keys before deleting old backups.

*'''Tip''': Always keep your Owner Key extremely safe — it is the only key that can reset everything.

==Expanding info box==

<div class="toccolours mw-collapsible mw-collapsed">
'''How to Change Your Active and Posting Keys on Hive (2026)'''

<div class="mw-collapsible-content">

To update your Active, Posting (or any) keys on Hive, you must perform a full **password reset**. This generates a new '''Master Password''' that automatically creates a fresh set of all keys (Owner, Active, Posting, Memo).

'''Critical Warnings'''
* If you lose the new Master Password or Owner Key, '''no one''' (not even Hive support) can recover your account.
* '''Backup everything''' (especially the new Master Password and all private keys) before clicking Update.
* You will need to manually add the new keys to Hive Keychain and other apps afterward.

'''Method 1: Official Hive Wallet (wallet.hive.blog)'''
# Go to [https://wallet.hive.blog wallet.hive.blog] (or directly to <code>https://wallet.hive.blog/@yourusername/permissions</code>).
# Log in using your current '''Owner Key''' or '''Master Password'''.
# Navigate to the '''Change Password''' section.
# Click '''"Click to Generate Password"'''.
# '''Save everything''': Copy the new Master Password and all displayed private/public keys. Store them securely offline.
# Re-enter the new Master Password in the confirmation field.
# Check all confirmation boxes.
# Click '''Update Password'''.

'''Method 2: Using PeakD (often easier)'''
# Log in to [https://peakd.com peakd.com] (usually via Hive Keychain).
# Go to your profile → '''Wallet''' → '''Keys & Permissions'''.
# Click the '''Change Password''' button.
# Authorize with your current '''Owner Key'''.
# Generate the new password, download/save all keys, then confirm the update.

'''After Updating'''
* Update Hive Keychain (remove old keys and import the new ones).
* Update any mobile apps (Ecency, Hive Wallet, etc.).
* Test logging in with the new keys before deleting old backups.

'''Tip''': Always keep your Owner Key extremely safe — it is the only key that can reset everything.

</div>
</div>

Hive Blockchain - buying/exchanging Hive Based Dollars $HBD

2026-04-19T12:48:22Z

AwesomO: Created page with "= Hive Blockchain Buying HBD = == Prerequisites == Before buying HBD, you must have a Hive account. It is recommended to use Hive Keychain for easy and secure access to your account. * Create a Hive account (see: ''Hive Blockchain Create Extra Accounts'') * Install Hive Keychain (browser extension) * Log in to your account using your keys == Buying HIVE from an Exchange == To obtain HBD, you will first need to buy HIVE from a cryptocurrency exchange. Example (UK): *..."

= Hive Blockchain Buying HBD =

== Prerequisites ==
Before buying HBD, you must have a Hive account.

It is recommended to use Hive Keychain for easy and secure access to your account.

* Create a Hive account (see: ''Hive Blockchain Create Extra Accounts'')
* Install Hive Keychain (browser extension)
* Log in to your account using your keys

== Buying HIVE from an Exchange ==
To obtain HBD, you will first need to buy HIVE from a cryptocurrency exchange.

Example (UK):
* https://www.mexc.com/en-GB/

Steps:
* Create and verify an account on the exchange
* Deposit funds (GBP, EUR, etc.)
* Buy HIVE

== Sending HIVE to Your Hive Account ==
Once you have purchased HIVE:

* Go to '''Withdraw''' on the exchange
* Enter your Hive username as the destination
* Double-check the username (transactions cannot be reversed)
* Send the HIVE

After a short time, the HIVE will appear in your Hive wallet.

== Swapping HIVE to HBD ==
To convert HIVE into HBD, you can use a Hive-based exchange:

* https://hivedex.io/

Steps:
* Connect your Hive account (via Hive Keychain)
* Select the HIVE → HBD market
* Enter the amount of HIVE to swap
* Confirm the transaction in Hive Keychain

Once completed, your HBD balance will be updated in your wallet.

== Notes ==
* Always verify URLs before logging in or signing transactions
* Keep your keys secure and never share them
* Test with a small amount first if you are new

And that's it — you now have HBD in your Hive account.

Hive Blockchain Create Create Extra Accounts

2026-04-19T12:33:01Z

AwesomO: Created page with "= Hive Blockchain Create Extra Accounts = == Free accounts == This is the on-ramp for your first account. https://signup.hive.io/ == Paid accounts == === Hive Keychain === * Download Hive Keychain (browser extension) * Log in with your '''Active Key''' (required to sign the ~3 HIVE account creation fee) * Click the ☰ (top left) → '''Accounts''' → '''Create Account''' * Enter a username If the username is available, you will proceed to the next stage where you..."

= Hive Blockchain Create Extra Accounts =

== Free accounts ==
This is the on-ramp for your first account.

https://signup.hive.io/

== Paid accounts ==

=== Hive Keychain ===

* Download Hive Keychain (browser extension)
* Log in with your '''Active Key''' (required to sign the ~3 HIVE account creation fee)
* Click the ☰ (top left) → '''Accounts''' → '''Create Account'''
* Enter a username

If the username is available, you will proceed to the next stage where your key pairs are shown.

'''Important:'''
When Hive Keychain is open on the key display screen, clicking outside the extension (e.g. to open a text editor) may close it. If this happens before saving, you will lose the generated keys and must restart the process.

* As soon as the keys are shown:
** Click '''Copy'''
** Tick all confirmation boxes
** Click '''Copy''' again to be safe
* Click '''Create''' to finalize the account
* Immediately paste your keys into a text file and back them up securely

And that's it — you have created a new Hive account.

Hive Blockchain Create Custom Coins

2026-04-19T12:23:06Z

AwesomO:

{{:LICENCE_HEADER_CC0}}
= v4call — How to Create Your Own Custom Token (e.g. CNOOBS) on Hive Engine =
From CompleteNoobs
F
This guide walks you through creating a custom Hive Engine token (example: '''CNOOBS''') in under 10 minutes. No coding required.

These tokens power the custom communication economy in v4call: you can set rates like "1 CNOOBS = 1 text message" or "10 CNOOBS = 1 hour video call", gift them to friends/family, or let blocked users bypass your blocklist if they hold enough of your token.

'''Why create your own token?'''
* Full control over supply and distribution.
* Real utility inside v4call (and any other Hive dApp that supports Hive Engine tokens).
* Scarcity you decide — perfect for personal or community communication economies.
* Transferable, tradable, and giftable via Hive Keychain or TribalDex.

'''Cost''': Approximately 100 BEE (Hive Engine's utility token). BEE price fluctuates — check current value on TribalDex or PeakD. This is a one-time creation fee.

'''Source''': Based on the official Hive Engine / TribalDex interface (as of 2026).

'''End result''': A live custom token (e.g. CNOOBS) that appears in users' Hive Keychain wallets and can be used in your v4call rates post.

== Contents ==
* [[#What_You_Need|1 What You Need]]
* [[#Step_1:_Get_Some_BEE_Tokens|2 Step 1: Get Some BEE Tokens]]
* [[#Step_2:_Log_In_to_TribalDex|3 Step 2: Log In to TribalDex]]
* [[#Step_3:_Create_Your_Token|4 Step 3: Create Your Token]]
* [[#Step_4:_Issue_Tokens_to_Yourself|5 Step 4: Issue Tokens to Yourself]]
* [[#Step_5:_Optional_-_Add_Metadata_(Logo_Description)|6 Step 5: Optional - Add Metadata (Logo & Description)]]
* [[#Step_6:_Distribute_Your_Tokens|7 Step 6: Distribute Your Tokens]]
* [[#Using_Your_Token_in_v4call|8 Using Your Token in v4call]]
* [[#Common_Problems_and_Fixes|9 Common Problems and Fixes]]
* [[#Quick_Reference|10 Quick Reference]]

== What You Need ==
* A Hive account (e.g. @noblemage) with Hive Keychain installed and the '''active key''' available.
* Some BEE tokens (≈100 BEE for creation fee).
* A web browser.

You do '''not''' need to run a node or write code.

== Step 1: Get Some BEE Tokens ==
BEE is the "gas" token for Hive Engine actions.

# Go to [https://tribaldex.com tribaldex.com] or any Hive Engine market (e.g. via PeakD wallet).
# Swap or buy BEE using HIVE or HBD (very easy with Keychain).
# Alternative: Many users get small amounts of BEE from community airdrops or by swapping on the built-in market.

Make sure you have at least 110 BEE to cover the fee plus a small buffer.

== Step 2: Log In to TribalDex ==
# Visit [https://tribaldex.com/tokens/create https://tribaldex.com/tokens/create]
# Click the login button at the top.
# Hive Keychain will pop up — approve the login with your '''active key''' (or posting key in some cases, but active is safest for token actions).

You are now logged in as your Hive account.

== Step 3: Create Your Token ==
On the token creation form, fill in the following fields carefully. Most cannot be changed later.

* '''Symbol''' — e.g. '''CNOOBS''' (uppercase, 1–10 characters, unique)
* '''Name''' — e.g. '''Cnoobs Coins'''
* '''Max Supply''' — Choose a number (e.g. 1,000,000). This is the absolute maximum that can ever exist. You can issue less.
* '''Precision''' — Usually '''3''' (allows 0.001 precision). You can only increase this later, not decrease.
* '''Website''' (optional) — Link to your profile or v4call server (e.g. https://call.yourdomain.com)
* '''Description''' (optional) — Short text like "Personal communication token for v4call — used for messages and calls with @cnoobz"

Double-check everything — the symbol especially cannot be changed.

Click '''Create Token'''.

Hive Keychain will ask you to approve a custom_json transaction. Confirm it.

Wait 3–10 seconds for confirmation on the blockchain.

Success message should appear: your token is now created!

== Step 4: Issue Tokens to Yourself ==
After creation, you usually start with zero balance.

# Go to [https://tribaldex.com/tokens/manage https://tribaldex.com/tokens/manage]
# Find your new token (CNOOBS) in the list.
# Click the '''Issue''' button.
# Enter the amount you want to issue to yourself (e.g. 10000).
# Confirm with Keychain.

You now hold the full issued supply.

== Step 5: Optional — Add Metadata (Logo & Description) ==
# Still on the manage page, click the edit icon for your token.
# Upload a square logo image (recommended 200x200 px or larger).
# Improve the description and website link.
# Save changes (another small Keychain transaction).

This makes your token look professional when users view it in wallets or markets.

== Step 6: Distribute Your Tokens ==
* Send to friends/family via Keychain → "Tokens" tab → Transfer.
* Airdrop to your community.
* Use in v4call rates (see below).
* List on TribalDex market if you want people to buy/sell them.

Tokens are fully transferable and appear instantly in recipients' Hive Keychain wallets.

== Using Your Token in v4call ==
Once you have your token:

# Go to your v4call server → /rate-editor.html
# In the rate editor (V2 format), create a new list like [LIST:token-holders]
# Set TOKEN:CNOOBS
# Define rates, e.g.:
** TEXT:1 CNOOBS
** VOICE:RING:5 CNOOBS;CONNECT:10 CNOOBS;RATE:20 CNOOBS/hr
# Your server will automatically verify balances using public Hive Engine RPC when someone tries to call or message you.

Blocked users can bypass your blocklist if you set ALLOW-IF-TOKEN:CNOOBS and they hold enough.

== Common Problems and Fixes ==
=== "Not enough BEE" error ===
Buy or swap more BEE on TribalDex.

=== Token symbol already taken ===
Choose a different symbol (add numbers or make it longer, e.g. CNOOBS2).

=== Transaction fails ===
Make sure you are using the '''active key''' in Keychain for token creation/issuing. Restart Keychain if needed.

=== Can't find my token after creation ===
Refresh the page or check https://hive-engine.com/tokens — it may take a few seconds to appear.

=== Want to issue more later? ===
You can issue up to your max supply at any time from the manage page.

== Quick Reference ==
{| class="wikitable"
|-
! Action !! Where to Do It
|-
| Create token || https://tribaldex.com/tokens/create
|-
| Manage / Issue tokens || https://tribaldex.com/tokens/manage
|-
| View all tokens || https://hive-engine.com/tokens
|-
| Swap BEE || TribalDex market
|-
| Check balance in Keychain || Hive Keychain extension → Tokens tab
|}

'''Next step for v4call users''': After creating your token, update your v4call-rates post using the improved rate-editor.html to include your custom token rates and blocklist bypass.

You now have your own personal communication currency on Hive!

[[Category:Hive]]
[[Category:Hive Engine]]
[[Category:v4call]]
[[Category:Token Creation]]
[[Category:Web3]]

Hive Blockchain Create Custom Coins

2026-04-19T12:22:14Z

AwesomO: Created page with "{{LICENCE_CC0}} = v4call — How to Create Your Own Custom Token (e.g. CNOOBS) on Hive Engine = From CompleteNoobs F This guide walks you through creating a custom Hive Engine token (example: '''CNOOBS''') in under 10 minutes. No coding required. These tokens power the custom communication economy in v4call: you can set rates like "1 CNOOBS = 1 text message" or "10 CNOOBS = 1 hour video call", gift them to friends/family, or let blocked users bypass your blocklist if th..."

{{LICENCE_CC0}}
= v4call — How to Create Your Own Custom Token (e.g. CNOOBS) on Hive Engine =
From CompleteNoobs
F
This guide walks you through creating a custom Hive Engine token (example: '''CNOOBS''') in under 10 minutes. No coding required.

These tokens power the custom communication economy in v4call: you can set rates like "1 CNOOBS = 1 text message" or "10 CNOOBS = 1 hour video call", gift them to friends/family, or let blocked users bypass your blocklist if they hold enough of your token.

'''Why create your own token?'''
* Full control over supply and distribution.
* Real utility inside v4call (and any other Hive dApp that supports Hive Engine tokens).
* Scarcity you decide — perfect for personal or community communication economies.
* Transferable, tradable, and giftable via Hive Keychain or TribalDex.

'''Cost''': Approximately 100 BEE (Hive Engine's utility token). BEE price fluctuates — check current value on TribalDex or PeakD. This is a one-time creation fee.

'''Source''': Based on the official Hive Engine / TribalDex interface (as of 2026).

'''End result''': A live custom token (e.g. CNOOBS) that appears in users' Hive Keychain wallets and can be used in your v4call rates post.

== Contents ==
* [[#What_You_Need|1 What You Need]]
* [[#Step_1:_Get_Some_BEE_Tokens|2 Step 1: Get Some BEE Tokens]]
* [[#Step_2:_Log_In_to_TribalDex|3 Step 2: Log In to TribalDex]]
* [[#Step_3:_Create_Your_Token|4 Step 3: Create Your Token]]
* [[#Step_4:_Issue_Tokens_to_Yourself|5 Step 4: Issue Tokens to Yourself]]
* [[#Step_5:_Optional_-_Add_Metadata_(Logo_Description)|6 Step 5: Optional - Add Metadata (Logo & Description)]]
* [[#Step_6:_Distribute_Your_Tokens|7 Step 6: Distribute Your Tokens]]
* [[#Using_Your_Token_in_v4call|8 Using Your Token in v4call]]
* [[#Common_Problems_and_Fixes|9 Common Problems and Fixes]]
* [[#Quick_Reference|10 Quick Reference]]

== What You Need ==
* A Hive account (e.g. @noblemage) with Hive Keychain installed and the '''active key''' available.
* Some BEE tokens (≈100 BEE for creation fee).
* A web browser.

You do '''not''' need to run a node or write code.

== Step 1: Get Some BEE Tokens ==
BEE is the "gas" token for Hive Engine actions.

# Go to [https://tribaldex.com tribaldex.com] or any Hive Engine market (e.g. via PeakD wallet).
# Swap or buy BEE using HIVE or HBD (very easy with Keychain).
# Alternative: Many users get small amounts of BEE from community airdrops or by swapping on the built-in market.

Make sure you have at least 110 BEE to cover the fee plus a small buffer.

== Step 2: Log In to TribalDex ==
# Visit [https://tribaldex.com/tokens/create https://tribaldex.com/tokens/create]
# Click the login button at the top.
# Hive Keychain will pop up — approve the login with your '''active key''' (or posting key in some cases, but active is safest for token actions).

You are now logged in as your Hive account.

== Step 3: Create Your Token ==
On the token creation form, fill in the following fields carefully. Most cannot be changed later.

* '''Symbol''' — e.g. '''CNOOBS''' (uppercase, 1–10 characters, unique)
* '''Name''' — e.g. '''Cnoobs Coins'''
* '''Max Supply''' — Choose a number (e.g. 1,000,000). This is the absolute maximum that can ever exist. You can issue less.
* '''Precision''' — Usually '''3''' (allows 0.001 precision). You can only increase this later, not decrease.
* '''Website''' (optional) — Link to your profile or v4call server (e.g. https://call.yourdomain.com)
* '''Description''' (optional) — Short text like "Personal communication token for v4call — used for messages and calls with @cnoobz"

Double-check everything — the symbol especially cannot be changed.

Click '''Create Token'''.

Hive Keychain will ask you to approve a custom_json transaction. Confirm it.

Wait 3–10 seconds for confirmation on the blockchain.

Success message should appear: your token is now created!

== Step 4: Issue Tokens to Yourself ==
After creation, you usually start with zero balance.

# Go to [https://tribaldex.com/tokens/manage https://tribaldex.com/tokens/manage]
# Find your new token (CNOOBS) in the list.
# Click the '''Issue''' button.
# Enter the amount you want to issue to yourself (e.g. 10000).
# Confirm with Keychain.

You now hold the full issued supply.

== Step 5: Optional — Add Metadata (Logo & Description) ==
# Still on the manage page, click the edit icon for your token.
# Upload a square logo image (recommended 200x200 px or larger).
# Improve the description and website link.
# Save changes (another small Keychain transaction).

This makes your token look professional when users view it in wallets or markets.

== Step 6: Distribute Your Tokens ==
* Send to friends/family via Keychain → "Tokens" tab → Transfer.
* Airdrop to your community.
* Use in v4call rates (see below).
* List on TribalDex market if you want people to buy/sell them.

Tokens are fully transferable and appear instantly in recipients' Hive Keychain wallets.

== Using Your Token in v4call ==
Once you have your token:

# Go to your v4call server → /rate-editor.html
# In the rate editor (V2 format), create a new list like [LIST:token-holders]
# Set TOKEN:CNOOBS
# Define rates, e.g.:
** TEXT:1 CNOOBS
** VOICE:RING:5 CNOOBS;CONNECT:10 CNOOBS;RATE:20 CNOOBS/hr
# Your server will automatically verify balances using public Hive Engine RPC when someone tries to call or message you.

Blocked users can bypass your blocklist if you set ALLOW-IF-TOKEN:CNOOBS and they hold enough.

== Common Problems and Fixes ==
=== "Not enough BEE" error ===
Buy or swap more BEE on TribalDex.

=== Token symbol already taken ===
Choose a different symbol (add numbers or make it longer, e.g. CNOOBS2).

=== Transaction fails ===
Make sure you are using the '''active key''' in Keychain for token creation/issuing. Restart Keychain if needed.

=== Can't find my token after creation ===
Refresh the page or check https://hive-engine.com/tokens — it may take a few seconds to appear.

=== Want to issue more later? ===
You can issue up to your max supply at any time from the manage page.

== Quick Reference ==
{| class="wikitable"
|-
! Action !! Where to Do It
|-
| Create token || https://tribaldex.com/tokens/create
|-
| Manage / Issue tokens || https://tribaldex.com/tokens/manage
|-
| View all tokens || https://hive-engine.com/tokens
|-
| Swap BEE || TribalDex market
|-
| Check balance in Keychain || Hive Keychain extension → Tokens tab
|}

'''Next step for v4call users''': After creating your token, update your v4call-rates post using the improved rate-editor.html to include your custom token rates and blocklist bypass.

You now have your own personal communication currency on Hive!

[[Category:Hive]]
[[Category:Hive Engine]]
[[Category:v4call]]
[[Category:Token Creation]]
[[Category:Web3]]

Html JavaScript Cookies PopUP Accept Basic

2026-04-16T15:14:19Z

Ubuntu 24.04 WebRTC lxc Intro Basics

2026-03-28T11:17:43Z

AwesomO: Created page with "= WebRTC Video Chat on Ubuntu 24.04 with LXC — Complete Beginner's Guide = * This walk through is tested on a ubuntu-mate 24.04 host. ** Guide written with help from claude.ai for Ubuntu 24.04 LTS (Noble Numbat). Node.js 20 LTS. Last verified March 2026 This guide walks you through setting up a working browser-based WebRTC video/audio chat application. The signalling server will run inside an '''LXC container''' on your Ubuntu 24.04 host machine, and you will conne..."

= WebRTC Video Chat on Ubuntu 24.04 with LXC — Complete Beginner's Guide =

* This walk through is tested on a ubuntu-mate 24.04 host.
** Guide written with help from claude.ai for Ubuntu 24.04 LTS (Noble Numbat). Node.js 20 LTS. Last verified March 2026

This guide walks you through setting up a working browser-based WebRTC video/audio chat application. The signalling server will run inside an '''LXC container''' on your Ubuntu 24.04 host machine, and you will connect to it from your browser.

== What You Will End Up With ==

* An LXC container running Ubuntu 24.04
* A Node.js signalling server inside that container
* A static HTML/JS frontend served from the container
* Two browser tabs (or two devices on your network) that can video/audio chat peer-to-peer

== How It Works (Plain English) ==

WebRTC lets two browsers talk directly to each other for audio and video. But before they can do that, they need to '''find each other''' and '''agree on connection details'''. This is called '''signalling'''.

Think of it like two people wanting to call each other — they first need to exchange phone numbers through a third party. The signalling server is that third party. Once the call is set up, the signalling server steps aside and the browsers talk directly.

[Browser A] <--WebSocket--> [Signalling Server in LXC] <--WebSocket--> [Browser B]
|
(only used during setup)
|
[Browser A] <============ WebRTC peer-to-peer audio/video ============> [Browser B]

----

== Part 1: Set Up the LXC Container ==

=== Step 1.1 — Install LXC on Your Host ===

Open a terminal on your Ubuntu 24.04 host and run:

* <b>NOTE: you can also install lxd with snap packages on ubuntu.</b>

sudo apt update
sudo apt install lxc lxc-utils -y

Check it installed correctly:

lxc-checkconfig

You should see mostly '''enabled''' next to each item. A few '''missing''' items are normal and will not affect this guide.

=== Step 1.2 — Create the Container ===

Create a new Ubuntu 24.04 container called <code>webrtc</code>:

sudo lxc-create -n webrtc -t download -- -d ubuntu -r noble -a amd64

This downloads the Ubuntu 24.04 (Noble) image. It may take a minute or two.

=== Step 1.3 — Start the Container ===

sudo lxc-start -n webrtc

Check it is running:

sudo lxc-ls --fancy

You should see <code>webrtc</code> listed with state '''RUNNING'''.

=== Step 1.4 — Log Into the Container ===

sudo lxc-attach -n webrtc

Your prompt will change — you are now '''inside''' the container. Everything from here until told otherwise runs inside the container.

=== Step 1.5 — Update the Container ===

apt update && apt upgrade -y

----

== Part 2: Install Node.js Inside the Container ==

=== Step 2.1 — Install Node.js ===

We will use the official NodeSource repository to get a recent version of Node.js:

apt install -y curl
curl -fsSL https://deb.nodesource.com/setup_20.x | bash -
apt install -y nodejs

Check the versions installed:

node -v
npm -v

You should see something like <code>v20.x.x</code> and <code>10.x.x</code>. Any version of Node 18 or higher is fine.

----

== Part 3: Create the Signalling Server ==

=== Step 3.1 — Create a Project Folder ===

mkdir /opt/webrtc
cd /opt/webrtc

=== Step 3.2 — Initialise the Node Project ===

npm init -y

This creates a <code>package.json</code> file. The <code>-y</code> flag just accepts all the defaults.

=== Step 3.3 — Install Dependencies ===

We need two packages:

* '''express''' — a simple web server to serve the HTML frontend
* '''socket.io''' — handles WebSocket connections for signalling

npm install express socket.io

=== Step 3.4 — Create the Server File ===

* <b>NOTE: <code>nano</code> will need to be installed in the container with <code>apt install nano -y</code></b>
Create the file:

nano server.js

Paste in the following code exactly. Use '''Ctrl+Shift+V''' to paste in the terminal:

<syntaxhighlight lang="javascript">
const express = require('express');
const http = require('http');
const { Server } = require('socket.io');
const path = require('path');

const app = express();
const server = http.createServer(app);
const io = new Server(server);

// Serve the frontend HTML file
app.use(express.static(path.join(__dirname, 'public')));

// Keep track of who is in each room
const rooms = {};

io.on('connection', (socket) => {
console.log('A user connected:', socket.id);

// User wants to join a room
socket.on('join', (room) => {
socket.join(room);

if (!rooms[room]) {
rooms[room] = [];
}

// Tell the new user who is already in the room
socket.emit('room-users', rooms[room]);

// Add this user to the room list
rooms[room].push(socket.id);

console.log(`${socket.id} joined room: ${room}`);
});

// Relay a WebRTC offer to a specific user
socket.on('offer', ({ to, offer }) => {
io.to(to).emit('offer', { from: socket.id, offer });
});

// Relay a WebRTC answer to a specific user
socket.on('answer', ({ to, answer }) => {
io.to(to).emit('answer', { from: socket.id, answer });
});

// Relay ICE candidates between peers
socket.on('ice-candidate', ({ to, candidate }) => {
io.to(to).emit('ice-candidate', { from: socket.id, candidate });
});

// Clean up when a user disconnects
socket.on('disconnect', () => {
for (const room in rooms) {
rooms[room] = rooms[room].filter((id) => id !== socket.id);
// Tell others in the room this user left
socket.to(room).emit('user-left', socket.id);
}
console.log('User disconnected:', socket.id);
});
});

const PORT = 3000;
server.listen(PORT, '0.0.0.0', () => {
console.log(`Signalling server running on port ${PORT}`);
});
</syntaxhighlight>

Save and exit: press '''Ctrl+X''', then '''Y''', then '''Enter'''.

=== Step 3.5 — Create the Frontend ===

Create a folder for the HTML file:

mkdir public
nano public/index.html

Paste in the following:

<syntaxhighlight lang="html">
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>WebRTC Chat</title>
<style>
* { box-sizing: border-box; margin: 0; padding: 0; }
body { font-family: sans-serif; background: #1a1a2e; color: #eee; display: flex; flex-direction: column; align-items: center; padding: 20px; }
h1 { margin-bottom: 20px; color: #e94560; }
#join-area { margin-bottom: 20px; display: flex; gap: 10px; }
input { padding: 10px; border-radius: 6px; border: none; font-size: 1rem; width: 200px; }
button { padding: 10px 20px; background: #e94560; color: white; border: none; border-radius: 6px; cursor: pointer; font-size: 1rem; }
button:hover { background: #c73652; }
#videos { display: flex; flex-wrap: wrap; gap: 10px; justify-content: center; }
video { width: 320px; height: 240px; background: #000; border-radius: 8px; border: 2px solid #e94560; }
#status { margin-top: 15px; font-size: 0.9rem; color: #aaa; }
</style>
</head>
<body>
<h1>WebRTC Chat</h1>
<div id="join-area">
<input id="room-input" type="text" placeholder="Enter room name" value="room1" />
<button onclick="joinRoom()">Join Room</button>
</div>
<div id="videos">
<video id="local-video" autoplay muted playsinline></video>
</div>
<p id="status">Enter a room name and click Join.</p>


<script src="/socket.io/socket.io.js"></script>
<script>
const socket = io();
let localStream;
const peers = {}; // peerId -> RTCPeerConnection

// STUN server config — Google's free public STUN server
const iceConfig = {
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
};

async function joinRoom() {
const room = document.getElementById('room-input').value.trim();
if (!room) return alert('Please enter a room name');

document.getElementById('status').textContent = 'Getting camera and microphone...';

try {
localStream = await navigator.mediaDevices.getUserMedia({ video: true, audio: true });
document.getElementById('local-video').srcObject = localStream;
} catch (err) {
alert('Could not access camera/microphone: ' + err.message);
return;
}

document.getElementById('status').textContent = `Joining room: ${room}`;
socket.emit('join', room);
}

// Server tells us who is already in the room
socket.on('room-users', async (users) => {
document.getElementById('status').textContent = `In room. ${users.length} other(s) here.`;
// Send an offer to each existing user
for (const userId of users) {
await createOffer(userId);
}
});

// A remote peer sent us an offer
socket.on('offer', async ({ from, offer }) => {
const pc = createPeerConnection(from);
await pc.setRemoteDescription(new RTCSessionDescription(offer));
const answer = await pc.createAnswer();
await pc.setLocalDescription(answer);
socket.emit('answer', { to: from, answer });
});

// A remote peer accepted our offer
socket.on('answer', async ({ from, answer }) => {
const pc = peers[from];
if (pc) await pc.setRemoteDescription(new RTCSessionDescription(answer));
});

// ICE candidate from a remote peer
socket.on('ice-candidate', async ({ from, candidate }) => {
const pc = peers[from];
if (pc && candidate) {
try { await pc.addIceCandidate(new RTCIceCandidate(candidate)); } catch (e) {}
}
});

// A user left the room
socket.on('user-left', (userId) => {
if (peers[userId]) {
peers[userId].close();
delete peers[userId];
}
const el = document.getElementById('video-' + userId);
if (el) el.remove();
document.getElementById('status').textContent = 'A user left the room.';
});

function createPeerConnection(peerId) {
const pc = new RTCPeerConnection(iceConfig);
peers[peerId] = pc;

// Add our local tracks so the remote peer gets our video/audio
localStream.getTracks().forEach((track) => pc.addTrack(track, localStream));

// When we get an ICE candidate, send it to the remote peer
pc.onicecandidate = ({ candidate }) => {
if (candidate) socket.emit('ice-candidate', { to: peerId, candidate });
};

// When we receive a remote track, display it
pc.ontrack = ({ streams }) => {
let videoEl = document.getElementById('video-' + peerId);
if (!videoEl) {
videoEl = document.createElement('video');
videoEl.id = 'video-' + peerId;
videoEl.autoplay = true;
videoEl.playsInline = true;
document.getElementById('videos').appendChild(videoEl);
}
videoEl.srcObject = streams[0];
};

return pc;
}

async function createOffer(peerId) {
const pc = createPeerConnection(peerId);
const offer = await pc.createOffer();
await pc.setLocalDescription(offer);
socket.emit('offer', { to: peerId, offer });
}
</script>
</body>
</html>
</syntaxhighlight>

Save and exit: '''Ctrl+X''', '''Y''', '''Enter'''.

----

== Part 4: Run the Server ==

=== Step 4.1 — Test it Manually First ===

Inside the container, run:

node /opt/webrtc/server.js

You should see:

Signalling server running on port 3000

Press '''Ctrl+C''' to stop it for now. We will set it up to run automatically in the next step.

=== Step 4.2 — Find the Container's IP Address ===

You need this to access the server from your host browser. Open a '''second terminal on your host''' (not inside the container) and run:

sudo lxc-ls --fancy

Look for your <code>webrtc</code> container and note the IP address in the '''IPV4''' column. It will look something like <code>10.0.3.15</code>.

=== Step 4.3 — Set Up Auto-start with systemd ===

We want the server to start automatically when the container boots. Back inside the container, create a systemd service file:

nano /etc/systemd/system/webrtc.service

Paste in:

<syntaxhighlight lang="ini">
[Unit]
Description=WebRTC Signalling Server
After=network.target

[Service]
Type=simple
WorkingDirectory=/opt/webrtc
ExecStart=/usr/bin/node /opt/webrtc/server.js
Restart=on-failure
RestartSec=5

[Install]
WantedBy=multi-user.target
</syntaxhighlight>

Save and exit. Then enable and start it:

systemctl daemon-reload
systemctl enable webrtc
systemctl start webrtc

Check it is running:

systemctl status webrtc

You should see '''active (running)''' in green.

----

== Part 5: Configure the LXC Container to Auto-start ==

We also want the container itself to start when your host boots.

Exit the container first (type <code>exit</code> or press '''Ctrl+D''' to return to your host terminal), then run:

sudo nano /var/lib/lxc/webrtc/config

Add these two lines at the bottom of the file:

lxc.start.auto = 1
lxc.start.delay = 5

Save and exit. Now the container (and the signalling server inside it) will start automatically on boot.

----

== Part 6: Open the App in Your Browser ==

=== Step 6.1 — Open the App ===

On your host machine, open a browser and go to:

http://<container-ip>:3000

Replace <code><container-ip></code> with the IP address you noted in Step 4.2. For example:

http://10.0.3.15:3000

You should see the WebRTC Chat page.

=== Step 6.2 — Test With Two Browser Tabs ===

# Open the app in '''Tab 1'''. Type a room name (e.g. <code>room1</code>) and click '''Join Room'''. Allow camera and microphone access when the browser asks.
# Open the app in '''Tab 2''' (you can use a private/incognito window to get a separate camera stream). Type the '''same room name''' and click '''Join Room'''.

The two tabs should now connect and you will see two video feeds.

<div class="toccolours mw-collapsible mw-collapsed">
NOTE:If you see <code>Could not access camera/microphone: Cannot read properties of undefined (reading 'getUserMedia')</code> <div class="mw-collapsible-content">

* <b>NOTE: if you see <code>Could not access camera/microphone: Cannot read properties of undefined (reading 'getUserMedia')</code> Then you need to go to step 7 and setup HTTPS</b>

This is the HTTPS issue mentioned in Part 7. Browsers block camera/microphone access on plain http:// from non-localhost addresses — navigator.mediaDevices is simply undefined on insecure origins.

Since you're accessing via the container's IP (e.g. http://10.0.3.15:3000), the browser sees it as insecure and disables the API entirely.

Quickest fix — use mkcert on your host:While you choose — here's a quick workaround you can do right now with zero config, if you just want to test immediately:

Option: Chrome flag to allow insecure origins

Open Chrome and go to: chrome://flags/#unsafely-treat-insecure-origin-as-secure

Paste your container URL (e.g. http://10.0.3.15:3000) into the text box and enable it

Relaunch Chrome when prompted

This tells Chrome to treat that specific IP as secure, enabling getUserMedia. Only use this for local dev/testing — never on a production machine.
Firefox equivalent: go to about:config, search for media.devices.insecure.enabled and set it to true.
Once you pick your preferred HTTPS method above I'll give you the exact step-by-step commands to do it properly inside your LXC container.

</div>
</div>

=== Step 6.3 — Test From Another Device on Your Network ===

On any other device connected to the same Wi-Fi or LAN, open a browser and go to the same URL:

http://<container-ip>:3000

Join the same room name and you should connect peer-to-peer with the other browser.

'''Note:''' Camera and microphone access in browsers requires either <code>localhost</code> or a secure HTTPS connection. For testing on the same machine, <code>http://localhost</code> works fine. For other devices on your network, you may need to set up HTTPS (see Part 7).

----

== Part 7: (Optional) Enable HTTPS for Other Devices ==

Browsers block camera/microphone access on plain HTTP from non-localhost addresses. To use this from other devices on your network, you have two options:

=== Option A — Use a Self-Signed Certificate (Quick) ===

Inside the container:

apt install -y openssl
cd /opt/webrtc
openssl req -x509 -newkey rsa:2048 -keyout key.pem -out cert.pem -days 365 -nodes -subj "/CN=localhost"

Edit <code>server.js</code> and replace the <code>http</code> section:

<syntaxhighlight lang="javascript">
const https = require('https');
const fs = require('fs');

const server = https.createServer({
key: fs.readFileSync('/opt/webrtc/key.pem'),
cert: fs.readFileSync('/opt/webrtc/cert.pem'),
}, app);
</syntaxhighlight>

<div class="toccolours mw-collapsible mw-collapsed">
Appended <code>server.js</code> file:
<div class="mw-collapsible-content">
<pre>
const express = require('express');
const https = require('https');
const { Server } = require('socket.io');
const path = require('path');

const app = express();
const fs = require('fs');

const server = https.createServer({
key: fs.readFileSync('/opt/webrtc/key.pem'),
cert: fs.readFileSync('/opt/webrtc/cert.pem'),
}, app);
const io = new Server(server);

// Serve the frontend HTML file
app.use(express.static(path.join(__dirname, 'public')));

// Keep track of who is in each room
const rooms = {};

io.on('connection', (socket) => {
console.log('A user connected:', socket.id);

// User wants to join a room
socket.on('join', (room) => {
socket.join(room);

if (!rooms[room]) {
rooms[room] = [];
}

// Tell the new user who is already in the room
socket.emit('room-users', rooms[room]);

// Add this user to the room list
rooms[room].push(socket.id);

console.log(`${socket.id} joined room: ${room}`);
});

// Relay a WebRTC offer to a specific user
socket.on('offer', ({ to, offer }) => {
io.to(to).emit('offer', { from: socket.id, offer });
});

// Relay a WebRTC answer to a specific user
socket.on('answer', ({ to, answer }) => {
io.to(to).emit('answer', { from: socket.id, answer });
});

// Relay ICE candidates between peers
socket.on('ice-candidate', ({ to, candidate }) => {
io.to(to).emit('ice-candidate', { from: socket.id, candidate });
});

// Clean up when a user disconnects
socket.on('disconnect', () => {
for (const room in rooms) {
rooms[room] = rooms[room].filter((id) => id !== socket.id);
// Tell others in the room this user left
socket.to(room).emit('user-left', socket.id);
}
console.log('User disconnected:', socket.id);
});
});

const PORT = 3000;
server.listen(PORT, '0.0.0.0', () => {
console.log(`Signalling server running on port ${PORT}`);
});

</pre>
</div>
</div>

Change <code>const http = require('http');</code> and <code>const server = http.createServer(app);</code> lines accordingly.

Restart the service:

systemctl restart webrtc

Access via:

https://<container-ip>:3000

Your browser will warn about the self-signed certificate — click '''Advanced''' and '''Proceed''' to continue.

=== Option B — Use mkcert (Trusted Certificate, Recommended) ===

<code>mkcert</code> creates locally trusted certificates without browser warnings.

On your '''host machine''':

sudo apt install mkcert
mkcert -install
mkcert <container-ip>

This creates <code><container-ip>.pem</code> and <code><container-ip>-key.pem</code>. Copy them into the container and follow the same server.js edits as Option A.

----

== Part 8: Useful Commands Reference ==

=== Managing the Container ===

{| class="wikitable"
|-
! Command !! What it does
|-
| <code>sudo lxc-start -n webrtc</code> || Start the container
|-
| <code>sudo lxc-stop -n webrtc</code> || Stop the container
|-
| <code>sudo lxc-attach -n webrtc</code> || Open a shell inside the container
|-
| <code>sudo lxc-ls --fancy</code> || List containers and their status/IP
|}

=== Managing the Server (run inside the container) ===

{| class="wikitable"
|-
! Command !! What it does
|-
| <code>systemctl status webrtc</code> || Check if the server is running
|-
| <code>systemctl restart webrtc</code> || Restart the server
|-
| <code>systemctl stop webrtc</code> || Stop the server
|-
| <code>journalctl -u webrtc -f</code> || Watch live server logs
|}

----

== Adding a ChatBox ==

* Added:
** A name input on the join screen so people aren't just "Anonymous"
** A chat panel on the right with message bubbles (your messages on the right, others on the left)
** Automatic link detection — any URL typed becomes a clickable link
** Enter to send, Shift+Enter for a newline
** A 500 character counter that turns red when you're close to the limit
** System messages when users join/leave
** A live peer count header showing how many others are in the room
** The textarea auto-resizes as you type

* Edit <code>public/index.html</code>

<div class="toccolours mw-collapsible mw-collapsed">
Appended <code>public/index.html</code>
<div class="mw-collapsible-content">
<pre>
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
<title>WebRTC Chat</title>
<link rel="preconnect" href="https://fonts.googleapis.com">
<link href="https://fonts.googleapis.com/css2?family=IBM+Plex+Mono:wght@400;600&family=IBM+Plex+Sans:wght@400;500;600&display=swap" rel="stylesheet">
<style>
:root {
--bg: #0d0f14;
--surface: #161920;
--border: #252932;
--accent: #4ade80;
--accent2: #22d3ee;
--muted: #4b5263;
--text: #e2e8f0;
--subtext: #8892a4;
--self-msg: #1a2e22;
--other-msg:#161d2e;
--danger: #f87171;
}

* { box-sizing: border-box; margin: 0; padding: 0; }

body {
font-family: 'IBM Plex Sans', sans-serif;
background: var(--bg);
color: var(--text);
height: 100dvh;
display: flex;
flex-direction: column;
overflow: hidden;
}

/* ── Top bar ── */
header {
display: flex;
align-items: center;
gap: 12px;
padding: 12px 20px;
border-bottom: 1px solid var(--border);
background: var(--surface);
flex-shrink: 0;
}
header h1 {
font-family: 'IBM Plex Mono', monospace;
font-size: 1rem;
color: var(--accent);
letter-spacing: 0.05em;
}
#room-badge {
font-family: 'IBM Plex Mono', monospace;
font-size: 0.75rem;
color: var(--subtext);
background: var(--border);
padding: 2px 10px;
border-radius: 999px;
display: none;
}
#status-dot {
width: 8px; height: 8px;
border-radius: 50%;
background: var(--muted);
margin-left: auto;
flex-shrink: 0;
transition: background 0.3s;
}
#status-dot.live { background: var(--accent); box-shadow: 0 0 6px var(--accent); }

/* ── Main layout ── */
main {
display: flex;
flex: 1;
overflow: hidden;
}

/* ── Join screen ── */
#join-screen {
display: flex;
flex-direction: column;
align-items: center;
justify-content: center;
gap: 16px;
flex: 1;
padding: 40px 20px;
}
#join-screen h2 {
font-family: 'IBM Plex Mono', monospace;
font-size: 1.4rem;
color: var(--accent);
}
#join-screen p { color: var(--subtext); font-size: 0.9rem; text-align: center; max-width: 340px; }
.field-group {
display: flex;
flex-direction: column;
gap: 8px;
width: 100%;
max-width: 320px;
}
.field-group label { font-size: 0.8rem; color: var(--subtext); font-family: 'IBM Plex Mono', monospace; }
input[type="text"] {
padding: 10px 14px;
background: var(--surface);
border: 1px solid var(--border);
border-radius: 6px;
color: var(--text);
font-family: 'IBM Plex Sans', sans-serif;
font-size: 0.95rem;
width: 100%;
transition: border-color 0.2s;
outline: none;
}
input[type="text"]:focus { border-color: var(--accent); }
button.primary {
padding: 11px 24px;
background: var(--accent);
color: #0d0f14;
border: none;
border-radius: 6px;
cursor: pointer;
font-family: 'IBM Plex Mono', monospace;
font-weight: 600;
font-size: 0.9rem;
width: 100%;
max-width: 320px;
transition: opacity 0.2s, transform 0.1s;
}
button.primary:hover { opacity: 0.85; }
button.primary:active { transform: scale(0.98); }

/* ── App layout (after join) ── */
#app { display: none; flex: 1; overflow: hidden; }
#app.visible { display: flex; }

/* ── Video panel ── */
#video-panel {
display: flex;
flex-direction: column;
gap: 0;
background: #0a0c10;
border-right: 1px solid var(--border);
overflow-y: auto;
flex-shrink: 0;
width: 340px;
}
@media (max-width: 700px) {
#app.visible { flex-direction: column; }
#video-panel { width: 100%; max-height: 220px; flex-direction: row; overflow-x: auto; overflow-y: hidden; border-right: none; border-bottom: 1px solid var(--border); }
}
.video-wrapper {
position: relative;
background: #000;
}
.video-wrapper video {
width: 100%;
display: block;
aspect-ratio: 4/3;
object-fit: cover;
}
.video-label {
position: absolute;
bottom: 6px; left: 8px;
font-family: 'IBM Plex Mono', monospace;
font-size: 0.7rem;
color: #fff;
background: rgba(0,0,0,0.55);
padding: 2px 7px;
border-radius: 4px;
}

/* ── Chat panel ── */
#chat-panel {
display: flex;
flex-direction: column;
flex: 1;
overflow: hidden;
}

#chat-header {
padding: 10px 16px;
border-bottom: 1px solid var(--border);
font-family: 'IBM Plex Mono', monospace;
font-size: 0.78rem;
color: var(--subtext);
background: var(--surface);
flex-shrink: 0;
}

#messages {
flex: 1;
overflow-y: auto;
padding: 16px;
display: flex;
flex-direction: column;
gap: 10px;
scroll-behavior: smooth;
}
#messages::-webkit-scrollbar { width: 4px; }
#messages::-webkit-scrollbar-track { background: transparent; }
#messages::-webkit-scrollbar-thumb { background: var(--border); border-radius: 2px; }

/* System messages */
.msg-system {
text-align: center;
font-size: 0.75rem;
color: var(--muted);
font-family: 'IBM Plex Mono', monospace;
padding: 2px 0;
}

/* Chat bubbles */
.msg-bubble {
display: flex;
flex-direction: column;
gap: 3px;
max-width: 85%;
}
.msg-bubble.self { align-self: flex-end; align-items: flex-end; }
.msg-bubble.other { align-self: flex-start; align-items: flex-start; }

.msg-meta {
font-size: 0.7rem;
color: var(--subtext);
font-family: 'IBM Plex Mono', monospace;
padding: 0 4px;
}
.msg-bubble.self .msg-meta { color: var(--accent); }

.msg-text {
padding: 9px 13px;
border-radius: 12px;
font-size: 0.9rem;
line-height: 1.5;
word-break: break-word;
}
.msg-bubble.self .msg-text {
background: var(--self-msg);
border: 1px solid rgba(74,222,128,0.2);
border-bottom-right-radius: 3px;
}
.msg-bubble.other .msg-text {
background: var(--other-msg);
border: 1px solid var(--border);
border-bottom-left-radius: 3px;
}

/* Links inside messages */
.msg-text a {
color: var(--accent2);
text-decoration: underline;
text-underline-offset: 2px;
word-break: break-all;
}
.msg-text a:hover { opacity: 0.8; }

/* ── Input bar ── */
#input-bar {
display: flex;
gap: 8px;
padding: 12px 16px;
border-top: 1px solid var(--border);
background: var(--surface);
flex-shrink: 0;
}
#msg-input {
flex: 1;
padding: 10px 14px;
background: var(--bg);
border: 1px solid var(--border);
border-radius: 8px;
color: var(--text);
font-family: 'IBM Plex Sans', sans-serif;
font-size: 0.9rem;
outline: none;
resize: none;
height: 42px;
max-height: 120px;
overflow-y: auto;
transition: border-color 0.2s;
}
#msg-input:focus { border-color: var(--accent); }
#send-btn {
padding: 0 16px;
background: var(--accent);
color: #0d0f14;
border: none;
border-radius: 8px;
cursor: pointer;
font-family: 'IBM Plex Mono', monospace;
font-weight: 600;
font-size: 0.85rem;
flex-shrink: 0;
transition: opacity 0.2s;
}
#send-btn:hover { opacity: 0.85; }
#char-count {
font-size: 0.7rem;
color: var(--muted);
font-family: 'IBM Plex Mono', monospace;
align-self: flex-end;
padding-bottom: 4px;
flex-shrink: 0;
width: 36px;
text-align: right;
}
#char-count.warn { color: var(--danger); }
</style>
</head>
<body>

<header>
<h1>// webrtc</h1>
<span id="room-badge"></span>
<div id="status-dot" title="Connecting..."></div>
</header>


<div id="join-screen">
<h2>join a room</h2>
<p>Enter your name and a room name. Anyone with the same room name will connect with you.</p>
<div class="field-group">
<label>YOUR NAME</label>
<input id="name-input" type="text" placeholder="e.g. Alice" maxlength="24" />
</div>
<div class="field-group">
<label>ROOM NAME</label>
<input id="room-input" type="text" placeholder="e.g. room1" value="room1" maxlength="32" />
</div>
<button class="primary" onclick="joinRoom()">Join Room →</button>
</div>


<main>
<div id="app">


<div id="video-panel">
<div class="video-wrapper" id="local-wrapper">
<video id="local-video" autoplay muted playsinline></video>
<div class="video-label" id="local-label">you</div>
</div>
</div>


<div id="chat-panel">
<div id="chat-header">MESSAGES — <span id="peer-count">0 others in room</span></div>
<div id="messages">
<div class="msg-system">Chat is end-to-end via your server. Video is peer-to-peer.</div>
</div>
<div id="input-bar">
<textarea id="msg-input" placeholder="Type a message… (Enter to send, Shift+Enter for newline)" rows="1"></textarea>
<span id="char-count">500</span>
<button id="send-btn" onclick="sendMessage()">Send</button>
</div>
</div>

</div>
</main>

<script src="/socket.io/socket.io.js"></script>
<script>
const socket = io();
let localStream;
let myName = 'Anonymous';
let currentRoom = '';
let peerCount = 0;
const peers = {};
const MAX_MSG = 500;

const iceConfig = {
iceServers: [{ urls: 'stun:stun.l.google.com:19302' }]
};

// ── Helpers ──────────────────────────────────────────────

// Detect URLs in text and wrap them in <a> tags
function linkify(text) {
const escaped = text
.replace(/&/g, '&')
.replace(/</g, '<')
.replace(/>/g, '>');
const urlRegex = /(https?:\/\/[^\s<>"]+)/g;
return escaped.replace(urlRegex, '<a href="$1" target="_blank" rel="noopener noreferrer">$1</a>');
}

function addMessage({ name, message, isSelf, isSystem }) {
const container = document.getElementById('messages');

if (isSystem) {
const el = document.createElement('div');
el.className = 'msg-system';
el.textContent = message;
container.appendChild(el);
} else {
const bubble = document.createElement('div');
bubble.className = 'msg-bubble ' + (isSelf ? 'self' : 'other');

const now = new Date().toLocaleTimeString([], { hour: '2-digit', minute: '2-digit' });
const meta = document.createElement('div');
meta.className = 'msg-meta';
meta.textContent = (isSelf ? 'you' : name) + ' · ' + now;

const body = document.createElement('div');
body.className = 'msg-text';
// Linkify and preserve newlines
body.innerHTML = linkify(message).replace(/\n/g, '<br>');

bubble.appendChild(meta);
bubble.appendChild(body);
container.appendChild(bubble);
}

// Auto-scroll to bottom
container.scrollTop = container.scrollHeight;
}

function updatePeerCount() {
document.getElementById('peer-count').textContent =
peerCount === 0 ? 'no others in room yet'
: peerCount === 1 ? '1 other in room'
: `${peerCount} others in room`;
}

// ── Join ─────────────────────────────────────────────────

async function joinRoom() {
const nameVal = document.getElementById('name-input').value.trim();
const roomVal = document.getElementById('room-input').value.trim();

if (!roomVal) { alert('Please enter a room name'); return; }
myName = nameVal || 'Anonymous';
currentRoom = roomVal;

try {
localStream = await navigator.mediaDevices.getUserMedia({ video: true, audio: true });
document.getElementById('local-video').srcObject = localStream;
document.getElementById('local-label').textContent = myName + ' (you)';
} catch (err) {
alert('Could not access camera/microphone: ' + err.message);
return;
}

document.getElementById('join-screen').style.display = 'none';
document.getElementById('app').classList.add('visible');
document.getElementById('room-badge').textContent = '# ' + currentRoom;
document.getElementById('room-badge').style.display = '';
document.getElementById('status-dot').classList.add('live');

socket.emit('join', currentRoom);
addMessage({ isSystem: true, message: `You joined #${currentRoom} as "${myName}"` });
updatePeerCount();
}

// ── Chat ─────────────────────────────────────────────────

function sendMessage() {
const input = document.getElementById('msg-input');
const text = input.value.trim();
if (!text || !currentRoom) return;
if (text.length > MAX_MSG) { alert(`Max ${MAX_MSG} characters`); return; }

socket.emit('chat-message', { room: currentRoom, message: text, name: myName });
addMessage({ name: myName, message: text, isSelf: true });

input.value = '';
input.style.height = '42px';
document.getElementById('char-count').textContent = MAX_MSG;
document.getElementById('char-count').classList.remove('warn');
}

socket.on('chat-message', ({ name, message }) => {
addMessage({ name, message, isSelf: false });
});

// Enter to send, Shift+Enter for newline
document.getElementById('msg-input').addEventListener('keydown', (e) => {
if (e.key === 'Enter' && !e.shiftKey) {
e.preventDefault();
sendMessage();
}
});

// Char counter + auto-resize textarea
document.getElementById('msg-input').addEventListener('input', function () {
const remaining = MAX_MSG - this.value.length;
const counter = document.getElementById('char-count');
counter.textContent = remaining;
counter.classList.toggle('warn', remaining < 50);
this.style.height = '42px';
this.style.height = Math.min(this.scrollHeight, 120) + 'px';
});

// ── WebRTC ───────────────────────────────────────────────

socket.on('room-users', async (users) => {
peerCount = users.length;
updatePeerCount();
for (const userId of users) {
await createOffer(userId);
}
});

socket.on('offer', async ({ from, offer }) => {
const pc = createPeerConnection(from);
await pc.setRemoteDescription(new RTCSessionDescription(offer));
const answer = await pc.createAnswer();
await pc.setLocalDescription(answer);
socket.emit('answer', { to: from, answer });
});

socket.on('answer', async ({ from, answer }) => {
const pc = peers[from];
if (pc) await pc.setRemoteDescription(new RTCSessionDescription(answer));
});

socket.on('ice-candidate', async ({ from, candidate }) => {
const pc = peers[from];
if (pc && candidate) {
try { await pc.addIceCandidate(new RTCIceCandidate(candidate)); } catch (e) {}
}
});

socket.on('user-left', (userId) => {
if (peers[userId]) { peers[userId].close(); delete peers[userId]; }
const el = document.getElementById('video-' + userId);
if (el) el.closest('.video-wrapper').remove();
peerCount = Math.max(0, peerCount - 1);
updatePeerCount();
addMessage({ isSystem: true, message: 'A user left the room.' });
});

function createPeerConnection(peerId) {
const pc = new RTCPeerConnection(iceConfig);
peers[peerId] = pc;

localStream.getTracks().forEach((track) => pc.addTrack(track, localStream));

pc.onicecandidate = ({ candidate }) => {
if (candidate) socket.emit('ice-candidate', { to: peerId, candidate });
};

pc.ontrack = ({ streams }) => {
let wrapper = document.getElementById('wrapper-' + peerId);
if (!wrapper) {
wrapper = document.createElement('div');
wrapper.className = 'video-wrapper';
wrapper.id = 'wrapper-' + peerId;

const vid = document.createElement('video');
vid.id = 'video-' + peerId;
vid.autoplay = true;
vid.playsInline = true;

const label = document.createElement('div');
label.className = 'video-label';
label.textContent = 'peer';

wrapper.appendChild(vid);
wrapper.appendChild(label);
document.getElementById('video-panel').appendChild(wrapper);

peerCount = Object.keys(peers).length;
updatePeerCount();
}
document.getElementById('video-' + peerId).srcObject = streams[0];
};

return pc;
}

async function createOffer(peerId) {
const pc = createPeerConnection(peerId);
const offer = await pc.createOffer();
await pc.setLocalDescription(offer);
socket.emit('offer', { to: peerId, offer });
}
</script>
</body>
</html>

</pre>
</div>
</div>

* Edit <code>server.js</code>
<div class="toccolours mw-collapsible mw-collapsed">
Appended <b>server.js</b>
<div class="mw-collapsible-content">

<pre>
const express = require('express');
const https = require('https');
const { Server } = require('socket.io');
const path = require('path');

const app = express();
const fs = require('fs');

const server = https.createServer({
key: fs.readFileSync('/opt/webrtc/key.pem'),
cert: fs.readFileSync('/opt/webrtc/cert.pem'),
}, app);
const io = new Server(server);

// Serve the frontend HTML file
app.use(express.static(path.join(__dirname, 'public')));

// Keep track of who is in each room
const rooms = {};

io.on('connection', (socket) => {
console.log('A user connected:', socket.id);

// User wants to join a room
socket.on('join', (room) => {
socket.join(room);

if (!rooms[room]) {
rooms[room] = [];
}

// Tell the new user who is already in the room
socket.emit('room-users', rooms[room]);

// Add this user to the room list
rooms[room].push(socket.id);

console.log(`${socket.id} joined room: ${room}`);
});

// Relay a WebRTC offer to a specific user
socket.on('offer', ({ to, offer }) => {
io.to(to).emit('offer', { from: socket.id, offer });
});

// Relay a WebRTC answer to a specific user
socket.on('answer', ({ to, answer }) => {
io.to(to).emit('answer', { from: socket.id, answer });
});

// Relay ICE candidates between peers
socket.on('ice-candidate', ({ to, candidate }) => {
io.to(to).emit('ice-candidate', { from: socket.id, candidate });
});

// ---- CHAT ----
// Relay a chat message to everyone else in the room
socket.on('chat-message', ({ room, message, name }) => {
// Broadcast to everyone in the room EXCEPT the sender
socket.to(room).emit('chat-message', {
from: socket.id,
name: name || 'Anonymous',
message,
time: new Date().toLocaleTimeString([], { hour: '2-digit', minute: '2-digit' })
});
});
// ---- END CHAT ----

// Clean up when a user disconnects
socket.on('disconnect', () => {
for (const room in rooms) {
rooms[room] = rooms[room].filter((id) => id !== socket.id);
// Tell others in the room this user left
socket.to(room).emit('user-left', socket.id);
}
console.log('User disconnected:', socket.id);
});
});

const PORT = 3000;
server.listen(PORT, '0.0.0.0', () => {
console.log(`Signalling server running on port ${PORT}`);
});

</pre>
</div>
</div>

* Restart webrtc: <code>systemctl restart webrtc</code>

Test - Should be working

== Troubleshooting ==

=== "Cannot connect to the page" ===
* Make sure the container is running: <code>sudo lxc-ls --fancy</code>
* Make sure the service is running: attach to the container and run <code>systemctl status webrtc</code>
* Double-check the IP address — it can change after a container restart. Assign a static IP via LXC config if needed.

=== "Camera/Microphone access denied" ===
* On non-localhost addresses, browsers require HTTPS. See Part 7.
* Make sure you clicked '''Allow''' (not Block) when the browser asked for permissions.
* Try in a different browser, or clear site permissions in browser settings.

=== Two tabs connect but no video appears ===
* This usually means ICE negotiation is failing. For local testing this should not happen.
* If testing across networks (not just local LAN), you will need a '''TURN server''' (e.g. coturn). This is beyond the scope of this guide.

=== Port 3000 not reachable ===
* Check no firewall is blocking it on the host: <code>sudo ufw status</code>
* LXC containers on the default <code>lxcbr0</code> bridge are reachable from the host by default. No port forwarding should be needed for local access.

User:ChandraArgueta

2026-01-06T20:23:02Z

AwesomO: Blanked the page

User:StephaniaEberhar

2026-01-06T20:22:16Z

AwesomO: Blanked the page

User:ReinaldoTonga76

2026-01-06T20:21:40Z

AwesomO: Blanked the page

Why New 18 Video Platforms Are Improving The User Experience

2026-01-06T20:21:05Z

AwesomO: Blanked the page

CompleteNoobs Docker Image 2

2025-09-02T14:46:21Z

AwesomO: /* 5.2: Test Extensions */

==todo==
* Use Dir for import export of xml.
* Min scripts - just setup mediawiki with extensions.

= Complete Noobs Docker Wiki Tutorial v0.2 =
* Version 0.2 - Simplified with manual import/export
* [[Docker_Install_Guide| Docker install guide]]

== Overview ==
This tutorial creates a MediaWiki Docker container with:
* MediaWiki 1.44
* PageNotice extension (for license notices)
* YouTube extension (for video embedding)
* Shared directory for XML import/export

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 1: Create Directory Structure ==

=== 1.1: Create Project Directory ===
<syntaxhighlight lang="bash">
mkdir ~/completenoobs-docker-v2
cd ~/completenoobs-docker-v2
</syntaxhighlight>

=== 1.2: Create Shared Directory ===
<syntaxhighlight lang="bash">
mkdir ~/wiki-container
</syntaxhighlight>
This directory will be used for importing and exporting XML files.

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44

# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3-pygments \
curl \
wget \
unzip \
nano \
vim \
git \
&& apt-get clean

# Copy setup script
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images
VOLUME /export

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
echo "Installing PageNotice extension..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."

echo "Installing YouTube extension..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."

cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'

# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug settings (remove in production)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Create helper scripts
cat > /var/www/html/export_wiki.sh << 'EXPORT_EOF'
#!/bin/bash
echo "=== Wiki Export Tool ==="
DATE=$(date +%Y%m%d)
OUTPUT_FILE="/export/${DATE}_wiki_export.xml"

echo "Exporting wiki to: $OUTPUT_FILE"
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:$OUTPUT_FILE

if [ -f "$OUTPUT_FILE" ]; then
echo "Export successful!"
echo "File saved to: $OUTPUT_FILE"
echo "On host system: ~/wiki-container/${DATE}_wiki_export.xml"
else
echo "Export failed!"
fi
EXPORT_EOF
chmod +x /var/www/html/export_wiki.sh

cat > /var/www/html/import_wiki.sh << 'IMPORT_EOF'
#!/bin/bash
echo "=== Wiki Import Tool ==="
echo ""
echo "Available XML files in /export:"
ls -la /export/*.xml 2>/dev/null || echo "No XML files found"
echo ""

if [ -z "$1" ]; then
echo "Usage: /var/www/html/import_wiki.sh <filename>"
echo "Example: /var/www/html/import_wiki.sh /export/wiki.xml"
exit 1
fi

if [ ! -f "$1" ]; then
echo "Error: File $1 not found!"
exit 1
fi

echo "Importing from: $1"
echo "This may take several minutes..."

php /var/www/html/maintenance/run.php importDump.php "$1"

if [ $? -eq 0 ]; then
echo "Import completed!"
echo "Rebuilding indexes..."
php /var/www/html/maintenance/run.php rebuildrecentchanges.php
php /var/www/html/maintenance/run.php initSiteStats.php
echo "Done!"
else
echo "Import failed! Check /tmp/mediawiki-debug.log for details"
fi
IMPORT_EOF
chmod +x /var/www/html/import_wiki.sh

# Create status check script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed ✓"
else
echo "PageNotice: Not installed ✗"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed ✓"
else
echo "YouTube: Not installed ✗"
fi
if [ -d "extensions/SyntaxHighlight_GeSHi" ]; then
echo "SyntaxHighlight: Installed ✓"
else
echo "SyntaxHighlight: Not installed ✗"
fi
echo ""
echo "=== Shared Directory ==="
if [ -d "/export" ]; then
echo "/export mounted ✓"
echo "Files in /export:"
ls -la /export/*.xml 2>/dev/null || echo " No XML files"
else
echo "/export not mounted ✗"
fi
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"

service mariadb stop
</syntaxhighlight>

=== 2.3: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "========================================="
echo "CompleteNoobs Wiki v0.2 Ready!"
echo "========================================="
echo ""
echo "Access: http://localhost:8080"
echo "Admin: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- MediaWiki 1.44"
echo "- PageNotice extension"
echo "- YouTube extension"
echo "- SyntaxHighlight extension"
echo "- Import/Export via ~/wiki-container"
echo ""
echo "Available commands:"
echo "- Export wiki: docker exec completenoobs_wiki /var/www/html/export_wiki.sh"
echo "- Import XML: docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/filename.xml"
echo "- Check status: docker exec completenoobs_wiki /var/www/html/check_status.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:v0.2 .
</syntaxhighlight>

=== 3.2: Run the Container with Shared Directory ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/wiki:v0.2
</syntaxhighlight>

== Step 4: Import/Export Operations ==

=== 4.1: Import an XML File ===
* https://xml.completenoobs.com/xmlDumps/
==== Place XML file in shared directory ====
<syntaxhighlight lang="bash">
# Copy your XML file to the shared directory
cp ~/Downloads/completenoobs.xml ~/wiki-container/
</syntaxhighlight>

==== Import the file ====
* All files in host <code>wiki-container</code> directory will also be in the containers <code>/export/</code> directory.
<syntaxhighlight lang="bash">
# Run the import command
docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/completenoobs.xml
</syntaxhighlight>

{{:Restore_the_completenoobs_Main_Page}}

=== 4.2: Export Your Wiki ===
<syntaxhighlight lang="bash">
# Export wiki to dated XML file
docker exec completenoobs_wiki /var/www/html/export_wiki.sh

# Check the exported file
ls -la ~/wiki-container/
</syntaxhighlight>

=== 4.3: Manual Import/Export (Advanced) ===

==== Access container shell ====
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

==== Manual export with custom filename ====
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:/export/my_wiki_backup.xml
exit
</syntaxhighlight>

==== Manual import with options ====
<syntaxhighlight lang="bash">
# Basic import
php /var/www/html/maintenance/run.php importDump.php /export/wiki.xml

# Import with image uploads
php /var/www/html/maintenance/run.php importDump.php --uploads /export/wiki.xml

# Then rebuild indexes
php /var/www/html/maintenance/run.php rebuildall.php
exit
</syntaxhighlight>

== Step 5: Testing and Verification ==

=== 5.1: Check Wiki Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

=== 5.2: Test Extensions ===
1. Visit http://localhost:8080
2. Login with admin / AdminPass123!
3. Create or edit a page and test:
* YouTube: Add/Test <nowiki><youtube>gBML6zuUpK0</youtube></nowiki> <code><youtube>gBML6zuUpK0</youtube></code>
* SyntaxHighlight: Add <nowiki><syntaxhighlight lang="python">print("Hello")</syntaxhighlight></nowiki>

=== 5.3: View Logs ===
<syntaxhighlight lang="bash">
# Container logs
docker logs completenoobs_wiki

# MediaWiki debug log
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

== Step 6: Common Operations ==

=== 6.1: Change Admin Password ===

==== Via Web Interface ====
1. Login at http://localhost:8080
2. Click username → Preferences
3. Go to Password tab
4. Change password

==== Via Terminal ====
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
exit
</syntaxhighlight>

=== 6.2: Backup Your Wiki ===
<syntaxhighlight lang="bash">
# Create dated backup
docker exec completenoobs_wiki /var/www/html/export_wiki.sh

# Copy to safe location
cp ~/wiki-container/*_wiki_export.xml ~/backups/
</syntaxhighlight>

=== 6.3: Restore from Backup ===
<syntaxhighlight lang="bash">
# Place backup in shared directory
cp ~/backups/20250101_wiki_export.xml ~/wiki-container/

# Import the backup
docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/20250101_wiki_export.xml
</syntaxhighlight>

=== 6.4: Complete Reset ===
<syntaxhighlight lang="bash">
# Stop and remove container
docker stop completenoobs_wiki
docker rm completenoobs_wiki

# Remove volumes (WARNING: This deletes all data!)
docker volume rm completenoobs_mysql completenoobs_images

# Rebuild and start fresh
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/wiki:v0.2
</syntaxhighlight>

== Troubleshooting ==

=== Permission Issues ===
If you encounter permission errors with the shared directory:
<syntaxhighlight lang="bash">
# Fix permissions on host
chmod 777 ~/wiki-container
</syntaxhighlight>

=== Import Failures ===
If imports fail, check:
* File exists in ~/wiki-container
* File is valid XML format
* Sufficient disk space
* Check debug log: <code>docker exec completenoobs_wiki tail /tmp/mediawiki-debug.log</code>

=== Container Won't Start ===
<syntaxhighlight lang="bash">
# Check logs
docker logs completenoobs_wiki

# Try interactive mode
docker run -it --rm completenoobs/wiki:v0.2 bash
</syntaxhighlight>

== Summary ==
This setup provides:
* Clean MediaWiki 1.44 installation
* Essential extensions (PageNotice, YouTube, SyntaxHighlight)
* Simple import/export via ~/wiki-container directory
* No automatic updates - full control over your content
* Easy backup and restore capabilities

The shared directory approach gives you complete control over when and what to import/export, making it ideal for:
* Migrating content between wikis
* Regular backups
* Sharing wiki content
* Testing imports before applying to production

CompleteNoobs Docker Image 2

2025-09-02T14:42:36Z

AwesomO: /* 5.2: Test Extensions */

==todo==
* Use Dir for import export of xml.
* Min scripts - just setup mediawiki with extensions.

= Complete Noobs Docker Wiki Tutorial v0.2 =
* Version 0.2 - Simplified with manual import/export
* [[Docker_Install_Guide| Docker install guide]]

== Overview ==
This tutorial creates a MediaWiki Docker container with:
* MediaWiki 1.44
* PageNotice extension (for license notices)
* YouTube extension (for video embedding)
* Shared directory for XML import/export

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 1: Create Directory Structure ==

=== 1.1: Create Project Directory ===
<syntaxhighlight lang="bash">
mkdir ~/completenoobs-docker-v2
cd ~/completenoobs-docker-v2
</syntaxhighlight>

=== 1.2: Create Shared Directory ===
<syntaxhighlight lang="bash">
mkdir ~/wiki-container
</syntaxhighlight>
This directory will be used for importing and exporting XML files.

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44

# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3-pygments \
curl \
wget \
unzip \
nano \
vim \
git \
&& apt-get clean

# Copy setup script
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images
VOLUME /export

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
echo "Installing PageNotice extension..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."

echo "Installing YouTube extension..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."

cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'

# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug settings (remove in production)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Create helper scripts
cat > /var/www/html/export_wiki.sh << 'EXPORT_EOF'
#!/bin/bash
echo "=== Wiki Export Tool ==="
DATE=$(date +%Y%m%d)
OUTPUT_FILE="/export/${DATE}_wiki_export.xml"

echo "Exporting wiki to: $OUTPUT_FILE"
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:$OUTPUT_FILE

if [ -f "$OUTPUT_FILE" ]; then
echo "Export successful!"
echo "File saved to: $OUTPUT_FILE"
echo "On host system: ~/wiki-container/${DATE}_wiki_export.xml"
else
echo "Export failed!"
fi
EXPORT_EOF
chmod +x /var/www/html/export_wiki.sh

cat > /var/www/html/import_wiki.sh << 'IMPORT_EOF'
#!/bin/bash
echo "=== Wiki Import Tool ==="
echo ""
echo "Available XML files in /export:"
ls -la /export/*.xml 2>/dev/null || echo "No XML files found"
echo ""

if [ -z "$1" ]; then
echo "Usage: /var/www/html/import_wiki.sh <filename>"
echo "Example: /var/www/html/import_wiki.sh /export/wiki.xml"
exit 1
fi

if [ ! -f "$1" ]; then
echo "Error: File $1 not found!"
exit 1
fi

echo "Importing from: $1"
echo "This may take several minutes..."

php /var/www/html/maintenance/run.php importDump.php "$1"

if [ $? -eq 0 ]; then
echo "Import completed!"
echo "Rebuilding indexes..."
php /var/www/html/maintenance/run.php rebuildrecentchanges.php
php /var/www/html/maintenance/run.php initSiteStats.php
echo "Done!"
else
echo "Import failed! Check /tmp/mediawiki-debug.log for details"
fi
IMPORT_EOF
chmod +x /var/www/html/import_wiki.sh

# Create status check script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed ✓"
else
echo "PageNotice: Not installed ✗"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed ✓"
else
echo "YouTube: Not installed ✗"
fi
if [ -d "extensions/SyntaxHighlight_GeSHi" ]; then
echo "SyntaxHighlight: Installed ✓"
else
echo "SyntaxHighlight: Not installed ✗"
fi
echo ""
echo "=== Shared Directory ==="
if [ -d "/export" ]; then
echo "/export mounted ✓"
echo "Files in /export:"
ls -la /export/*.xml 2>/dev/null || echo " No XML files"
else
echo "/export not mounted ✗"
fi
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"

service mariadb stop
</syntaxhighlight>

=== 2.3: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "========================================="
echo "CompleteNoobs Wiki v0.2 Ready!"
echo "========================================="
echo ""
echo "Access: http://localhost:8080"
echo "Admin: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- MediaWiki 1.44"
echo "- PageNotice extension"
echo "- YouTube extension"
echo "- SyntaxHighlight extension"
echo "- Import/Export via ~/wiki-container"
echo ""
echo "Available commands:"
echo "- Export wiki: docker exec completenoobs_wiki /var/www/html/export_wiki.sh"
echo "- Import XML: docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/filename.xml"
echo "- Check status: docker exec completenoobs_wiki /var/www/html/check_status.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:v0.2 .
</syntaxhighlight>

=== 3.2: Run the Container with Shared Directory ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/wiki:v0.2
</syntaxhighlight>

== Step 4: Import/Export Operations ==

=== 4.1: Import an XML File ===
* https://xml.completenoobs.com/xmlDumps/
==== Place XML file in shared directory ====
<syntaxhighlight lang="bash">
# Copy your XML file to the shared directory
cp ~/Downloads/completenoobs.xml ~/wiki-container/
</syntaxhighlight>

==== Import the file ====
* All files in host <code>wiki-container</code> directory will also be in the containers <code>/export/</code> directory.
<syntaxhighlight lang="bash">
# Run the import command
docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/completenoobs.xml
</syntaxhighlight>

{{:Restore_the_completenoobs_Main_Page}}

=== 4.2: Export Your Wiki ===
<syntaxhighlight lang="bash">
# Export wiki to dated XML file
docker exec completenoobs_wiki /var/www/html/export_wiki.sh

# Check the exported file
ls -la ~/wiki-container/
</syntaxhighlight>

=== 4.3: Manual Import/Export (Advanced) ===

==== Access container shell ====
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

==== Manual export with custom filename ====
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:/export/my_wiki_backup.xml
exit
</syntaxhighlight>

==== Manual import with options ====
<syntaxhighlight lang="bash">
# Basic import
php /var/www/html/maintenance/run.php importDump.php /export/wiki.xml

# Import with image uploads
php /var/www/html/maintenance/run.php importDump.php --uploads /export/wiki.xml

# Then rebuild indexes
php /var/www/html/maintenance/run.php rebuildall.php
exit
</syntaxhighlight>

== Step 5: Testing and Verification ==

=== 5.1: Check Wiki Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

=== 5.2: Test Extensions ===
1. Visit http://localhost:8080
2. Login with admin / AdminPass123!
3. Create or edit a page and test:
* YouTube: Add <code><youtube>gBML6zuUpK0</youtube></code>
* SyntaxHighlight: Add <nowiki><syntaxhighlight lang="python">print("Hello")</syntaxhighlight></nowiki>

=== 5.3: View Logs ===
<syntaxhighlight lang="bash">
# Container logs
docker logs completenoobs_wiki

# MediaWiki debug log
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

== Step 6: Common Operations ==

=== 6.1: Change Admin Password ===

==== Via Web Interface ====
1. Login at http://localhost:8080
2. Click username → Preferences
3. Go to Password tab
4. Change password

==== Via Terminal ====
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
exit
</syntaxhighlight>

=== 6.2: Backup Your Wiki ===
<syntaxhighlight lang="bash">
# Create dated backup
docker exec completenoobs_wiki /var/www/html/export_wiki.sh

# Copy to safe location
cp ~/wiki-container/*_wiki_export.xml ~/backups/
</syntaxhighlight>

=== 6.3: Restore from Backup ===
<syntaxhighlight lang="bash">
# Place backup in shared directory
cp ~/backups/20250101_wiki_export.xml ~/wiki-container/

# Import the backup
docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/20250101_wiki_export.xml
</syntaxhighlight>

=== 6.4: Complete Reset ===
<syntaxhighlight lang="bash">
# Stop and remove container
docker stop completenoobs_wiki
docker rm completenoobs_wiki

# Remove volumes (WARNING: This deletes all data!)
docker volume rm completenoobs_mysql completenoobs_images

# Rebuild and start fresh
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/wiki:v0.2
</syntaxhighlight>

== Troubleshooting ==

=== Permission Issues ===
If you encounter permission errors with the shared directory:
<syntaxhighlight lang="bash">
# Fix permissions on host
chmod 777 ~/wiki-container
</syntaxhighlight>

=== Import Failures ===
If imports fail, check:
* File exists in ~/wiki-container
* File is valid XML format
* Sufficient disk space
* Check debug log: <code>docker exec completenoobs_wiki tail /tmp/mediawiki-debug.log</code>

=== Container Won't Start ===
<syntaxhighlight lang="bash">
# Check logs
docker logs completenoobs_wiki

# Try interactive mode
docker run -it --rm completenoobs/wiki:v0.2 bash
</syntaxhighlight>

== Summary ==
This setup provides:
* Clean MediaWiki 1.44 installation
* Essential extensions (PageNotice, YouTube, SyntaxHighlight)
* Simple import/export via ~/wiki-container directory
* No automatic updates - full control over your content
* Easy backup and restore capabilities

The shared directory approach gives you complete control over when and what to import/export, making it ideal for:
* Migrating content between wikis
* Regular backups
* Sharing wiki content
* Testing imports before applying to production

CompleteNoobs Docker Image Install

2025-09-02T14:36:54Z

AwesomO:

* [[CompleteNoobs_Docker_Image_0.2_Install_Basics| cnoobs-wiki 0.2 basic install guide]]

CompleteNoobs Docker Image 0.2 Install Basics

2025-09-02T14:31:39Z

AwesomO: /* Create directory for file sharing */

* Requires docker installed on system

== Download image==
* Download the completenoobs container image.
<code>docker pull completenoobs/cnoobs-wiki:0.2</code>

== Create directory for file sharing ==
* If you do not create this directory - docker will create one for you when you run the <code>docker run</code> command.
** If docker run creates the directory, you will not have permissions to send data to that directory.
** Change permission's if that happens <code>sudo chmod 777 ~/wiki-container</code>
<code>mkdir ~/wiki-container</code>

== Run image ==

<pre>
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.2
</pre>

== Download XMl ==

* https://xml.completenoobs.com/xmlDumps/
Download an xml file, like:<code>01_09_25.Noobs.xml</code>
* Move to <code>~/wiki-container/</code> directory

== Import XML ==

<code>docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/01_09_25.Noobs.xml</code>

== Check Wiki ==
* In browser go to this address
<code>http://localhost:8080</code>
<br>
{{:Restore_the_completenoobs_Main_Page}}

==Change Admin Password==

* Can be done with 'Web Browser GUI' or 'Terminal'
* Default Password for user <b>Admin</b> = <code>AdminPass123!</code>
=== Via Web Interface ===
1. Login at http://localhost:8080
2. Click username → Preferences
3. Go to Password tab
4. Change password

=== Via Terminal ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
exit
</syntaxhighlight>

==Export a backup of your wiki==
* This will create a backup of your wiki to a dated.xml file <code>20250902_wiki_export.xml</code>, which you can find in your <code>~/wiki-container</code> directory on host, or <code>/export/</code> directory in container.
<code>docker exec completenoobs_wiki /var/www/html/export_wiki.sh</code>

==Remove container==

To completely remove the <code>completenoobs/cnoobs-wiki:0.1</code> container and image from your Ubuntu 24.04 system, follow these steps. <br>
You can also remove associated persistent storage volumes if they were created.<br><br>

<b>Step 1: Stop and Remove the Container</b><br>
If the container is running, stop it and then remove it.<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
</syntaxhighlight>
Alternatively, stop and remove in one command:<br>
<syntaxhighlight lang="bash">
docker rm -f completenoobs_wiki
</syntaxhighlight><br>

<b>Step 2: Remove the Docker Image</b><br>
Remove the <code>completenoobs/cnoobs-wiki:0.2</code> image.<br>
<syntaxhighlight lang="bash">
docker rmi completenoobs/cnoobs-wiki:0.2
</syntaxhighlight>
Note: If the image is in use by other containers, remove those containers first or use <code>docker rmi -f completenoobs/cnoobs-wiki:0.1</code> to force removal (use with caution).<br><br>

<b>Step 3: Remove Persistent Storage Volumes (Optional)</b><br>
If you used persistent storage, remove the associated volumes to free up space.<br>
<syntaxhighlight lang="bash">
docker volume rm completenoobs_mysql completenoobs_images
</syntaxhighlight>
Note: Ensure no other containers are using these volumes, as this will delete all stored data.<br><br>

<b>Step 4: Verify Removal</b><br>
Check that the container, image, and volumes are removed.<br>
- List all containers (including stopped ones):<br>
<syntaxhighlight lang="bash">
docker ps -a
</syntaxhighlight>
- List all images:<br>
<syntaxhighlight lang="bash">
docker images
</syntaxhighlight>
- List all volumes:<br>
<syntaxhighlight lang="bash">
docker volume ls
</syntaxhighlight>
If any items remain, repeat the relevant removal commands or check for dependencies.

CompleteNoobs Docker Image 0.2 Install Basics

2025-09-02T14:31:06Z

AwesomO: Created page with " * Requires docker installed on system == Download image== * Download the completenoobs container image. <code>docker pull completenoobs/cnoobs-wiki:0.2</code> == Create directory for file sharing == * If you do not create this file - docker will create one for you when you run the <code>docker run</code> command. ** If docker run creates the file, you will not have permissions to send data to that directory. ** Change permission's if that happens <code>sudo chmod 777..."

* Requires docker installed on system

== Download image==
* Download the completenoobs container image.
<code>docker pull completenoobs/cnoobs-wiki:0.2</code>

== Create directory for file sharing ==
* If you do not create this file - docker will create one for you when you run the <code>docker run</code> command.
** If docker run creates the file, you will not have permissions to send data to that directory.
** Change permission's if that happens <code>sudo chmod 777 ~/wiki-container</code>
<code>mkdir ~/wiki-container</code>

== Run image ==

<pre>
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.2
</pre>

== Download XMl ==

* https://xml.completenoobs.com/xmlDumps/
Download an xml file, like:<code>01_09_25.Noobs.xml</code>
* Move to <code>~/wiki-container/</code> directory

== Import XML ==

<code>docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/01_09_25.Noobs.xml</code>

== Check Wiki ==
* In browser go to this address
<code>http://localhost:8080</code>
<br>
{{:Restore_the_completenoobs_Main_Page}}

==Change Admin Password==

* Can be done with 'Web Browser GUI' or 'Terminal'
* Default Password for user <b>Admin</b> = <code>AdminPass123!</code>
=== Via Web Interface ===
1. Login at http://localhost:8080
2. Click username → Preferences
3. Go to Password tab
4. Change password

=== Via Terminal ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
exit
</syntaxhighlight>

==Export a backup of your wiki==
* This will create a backup of your wiki to a dated.xml file <code>20250902_wiki_export.xml</code>, which you can find in your <code>~/wiki-container</code> directory on host, or <code>/export/</code> directory in container.
<code>docker exec completenoobs_wiki /var/www/html/export_wiki.sh</code>

==Remove container==

To completely remove the <code>completenoobs/cnoobs-wiki:0.1</code> container and image from your Ubuntu 24.04 system, follow these steps. <br>
You can also remove associated persistent storage volumes if they were created.<br><br>

<b>Step 1: Stop and Remove the Container</b><br>
If the container is running, stop it and then remove it.<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
</syntaxhighlight>
Alternatively, stop and remove in one command:<br>
<syntaxhighlight lang="bash">
docker rm -f completenoobs_wiki
</syntaxhighlight><br>

<b>Step 2: Remove the Docker Image</b><br>
Remove the <code>completenoobs/cnoobs-wiki:0.2</code> image.<br>
<syntaxhighlight lang="bash">
docker rmi completenoobs/cnoobs-wiki:0.2
</syntaxhighlight>
Note: If the image is in use by other containers, remove those containers first or use <code>docker rmi -f completenoobs/cnoobs-wiki:0.1</code> to force removal (use with caution).<br><br>

<b>Step 3: Remove Persistent Storage Volumes (Optional)</b><br>
If you used persistent storage, remove the associated volumes to free up space.<br>
<syntaxhighlight lang="bash">
docker volume rm completenoobs_mysql completenoobs_images
</syntaxhighlight>
Note: Ensure no other containers are using these volumes, as this will delete all stored data.<br><br>

<b>Step 4: Verify Removal</b><br>
Check that the container, image, and volumes are removed.<br>
- List all containers (including stopped ones):<br>
<syntaxhighlight lang="bash">
docker ps -a
</syntaxhighlight>
- List all images:<br>
<syntaxhighlight lang="bash">
docker images
</syntaxhighlight>
- List all volumes:<br>
<syntaxhighlight lang="bash">
docker volume ls
</syntaxhighlight>
If any items remain, repeat the relevant removal commands or check for dependencies.

CompleteNoobs Docker Image Install

2025-09-02T12:27:21Z

AwesomO: Created page with "placeholder"

placeholder

CompleteNoobs Docker Image 2

2025-09-02T12:24:39Z

AwesomO: Created page with " ==todo== * Use Dir for import export of xml. * Min scripts - just setup mediawiki with extensions. = Complete Noobs Docker Wiki Tutorial v0.2 = * Version 0.2 - Simplified with manual import/export * Docker install guide == Overview == This tutorial creates a MediaWiki Docker container with: * MediaWiki 1.44 * PageNotice extension (for license notices) * YouTube extension (for video embedding) * Shared directory for XML import/export == Prere..."

==todo==
* Use Dir for import export of xml.
* Min scripts - just setup mediawiki with extensions.

= Complete Noobs Docker Wiki Tutorial v0.2 =
* Version 0.2 - Simplified with manual import/export
* [[Docker_Install_Guide| Docker install guide]]

== Overview ==
This tutorial creates a MediaWiki Docker container with:
* MediaWiki 1.44
* PageNotice extension (for license notices)
* YouTube extension (for video embedding)
* Shared directory for XML import/export

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 1: Create Directory Structure ==

=== 1.1: Create Project Directory ===
<syntaxhighlight lang="bash">
mkdir ~/completenoobs-docker-v2
cd ~/completenoobs-docker-v2
</syntaxhighlight>

=== 1.2: Create Shared Directory ===
<syntaxhighlight lang="bash">
mkdir ~/wiki-container
</syntaxhighlight>
This directory will be used for importing and exporting XML files.

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44

# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3-pygments \
curl \
wget \
unzip \
nano \
vim \
git \
&& apt-get clean

# Copy setup script
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images
VOLUME /export

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
echo "Installing PageNotice extension..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."

echo "Installing YouTube extension..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."

cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'

# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug settings (remove in production)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Create helper scripts
cat > /var/www/html/export_wiki.sh << 'EXPORT_EOF'
#!/bin/bash
echo "=== Wiki Export Tool ==="
DATE=$(date +%Y%m%d)
OUTPUT_FILE="/export/${DATE}_wiki_export.xml"

echo "Exporting wiki to: $OUTPUT_FILE"
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:$OUTPUT_FILE

if [ -f "$OUTPUT_FILE" ]; then
echo "Export successful!"
echo "File saved to: $OUTPUT_FILE"
echo "On host system: ~/wiki-container/${DATE}_wiki_export.xml"
else
echo "Export failed!"
fi
EXPORT_EOF
chmod +x /var/www/html/export_wiki.sh

cat > /var/www/html/import_wiki.sh << 'IMPORT_EOF'
#!/bin/bash
echo "=== Wiki Import Tool ==="
echo ""
echo "Available XML files in /export:"
ls -la /export/*.xml 2>/dev/null || echo "No XML files found"
echo ""

if [ -z "$1" ]; then
echo "Usage: /var/www/html/import_wiki.sh <filename>"
echo "Example: /var/www/html/import_wiki.sh /export/wiki.xml"
exit 1
fi

if [ ! -f "$1" ]; then
echo "Error: File $1 not found!"
exit 1
fi

echo "Importing from: $1"
echo "This may take several minutes..."

php /var/www/html/maintenance/run.php importDump.php "$1"

if [ $? -eq 0 ]; then
echo "Import completed!"
echo "Rebuilding indexes..."
php /var/www/html/maintenance/run.php rebuildrecentchanges.php
php /var/www/html/maintenance/run.php initSiteStats.php
echo "Done!"
else
echo "Import failed! Check /tmp/mediawiki-debug.log for details"
fi
IMPORT_EOF
chmod +x /var/www/html/import_wiki.sh

# Create status check script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed ✓"
else
echo "PageNotice: Not installed ✗"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed ✓"
else
echo "YouTube: Not installed ✗"
fi
if [ -d "extensions/SyntaxHighlight_GeSHi" ]; then
echo "SyntaxHighlight: Installed ✓"
else
echo "SyntaxHighlight: Not installed ✗"
fi
echo ""
echo "=== Shared Directory ==="
if [ -d "/export" ]; then
echo "/export mounted ✓"
echo "Files in /export:"
ls -la /export/*.xml 2>/dev/null || echo " No XML files"
else
echo "/export not mounted ✗"
fi
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"

service mariadb stop
</syntaxhighlight>

=== 2.3: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "========================================="
echo "CompleteNoobs Wiki v0.2 Ready!"
echo "========================================="
echo ""
echo "Access: http://localhost:8080"
echo "Admin: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- MediaWiki 1.44"
echo "- PageNotice extension"
echo "- YouTube extension"
echo "- SyntaxHighlight extension"
echo "- Import/Export via ~/wiki-container"
echo ""
echo "Available commands:"
echo "- Export wiki: docker exec completenoobs_wiki /var/www/html/export_wiki.sh"
echo "- Import XML: docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/filename.xml"
echo "- Check status: docker exec completenoobs_wiki /var/www/html/check_status.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:v0.2 .
</syntaxhighlight>

=== 3.2: Run the Container with Shared Directory ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/wiki:v0.2
</syntaxhighlight>

== Step 4: Import/Export Operations ==

=== 4.1: Import an XML File ===
* https://xml.completenoobs.com/xmlDumps/
==== Place XML file in shared directory ====
<syntaxhighlight lang="bash">
# Copy your XML file to the shared directory
cp ~/Downloads/completenoobs.xml ~/wiki-container/
</syntaxhighlight>

==== Import the file ====
* All files in host <code>wiki-container</code> directory will also be in the containers <code>/export/</code> directory.
<syntaxhighlight lang="bash">
# Run the import command
docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/completenoobs.xml
</syntaxhighlight>

{{:Restore_the_completenoobs_Main_Page}}

=== 4.2: Export Your Wiki ===
<syntaxhighlight lang="bash">
# Export wiki to dated XML file
docker exec completenoobs_wiki /var/www/html/export_wiki.sh

# Check the exported file
ls -la ~/wiki-container/
</syntaxhighlight>

=== 4.3: Manual Import/Export (Advanced) ===

==== Access container shell ====
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

==== Manual export with custom filename ====
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:/export/my_wiki_backup.xml
exit
</syntaxhighlight>

==== Manual import with options ====
<syntaxhighlight lang="bash">
# Basic import
php /var/www/html/maintenance/run.php importDump.php /export/wiki.xml

# Import with image uploads
php /var/www/html/maintenance/run.php importDump.php --uploads /export/wiki.xml

# Then rebuild indexes
php /var/www/html/maintenance/run.php rebuildall.php
exit
</syntaxhighlight>

== Step 5: Testing and Verification ==

=== 5.1: Check Wiki Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

=== 5.2: Test Extensions ===
1. Visit http://localhost:8080
2. Login with admin / AdminPass123!
3. Create or edit a page and test:
* YouTube: Add <code><youtube>VIDEO_ID</youtube></code>
* SyntaxHighlight: Add <nowiki><syntaxhighlight lang="python">print("Hello")</syntaxhighlight></nowiki>

=== 5.3: View Logs ===
<syntaxhighlight lang="bash">
# Container logs
docker logs completenoobs_wiki

# MediaWiki debug log
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

== Step 6: Common Operations ==

=== 6.1: Change Admin Password ===

==== Via Web Interface ====
1. Login at http://localhost:8080
2. Click username → Preferences
3. Go to Password tab
4. Change password

==== Via Terminal ====
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
exit
</syntaxhighlight>

=== 6.2: Backup Your Wiki ===
<syntaxhighlight lang="bash">
# Create dated backup
docker exec completenoobs_wiki /var/www/html/export_wiki.sh

# Copy to safe location
cp ~/wiki-container/*_wiki_export.xml ~/backups/
</syntaxhighlight>

=== 6.3: Restore from Backup ===
<syntaxhighlight lang="bash">
# Place backup in shared directory
cp ~/backups/20250101_wiki_export.xml ~/wiki-container/

# Import the backup
docker exec completenoobs_wiki /var/www/html/import_wiki.sh /export/20250101_wiki_export.xml
</syntaxhighlight>

=== 6.4: Complete Reset ===
<syntaxhighlight lang="bash">
# Stop and remove container
docker stop completenoobs_wiki
docker rm completenoobs_wiki

# Remove volumes (WARNING: This deletes all data!)
docker volume rm completenoobs_mysql completenoobs_images

# Rebuild and start fresh
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/wiki:v0.2
</syntaxhighlight>

== Troubleshooting ==

=== Permission Issues ===
If you encounter permission errors with the shared directory:
<syntaxhighlight lang="bash">
# Fix permissions on host
chmod 777 ~/wiki-container
</syntaxhighlight>

=== Import Failures ===
If imports fail, check:
* File exists in ~/wiki-container
* File is valid XML format
* Sufficient disk space
* Check debug log: <code>docker exec completenoobs_wiki tail /tmp/mediawiki-debug.log</code>

=== Container Won't Start ===
<syntaxhighlight lang="bash">
# Check logs
docker logs completenoobs_wiki

# Try interactive mode
docker run -it --rm completenoobs/wiki:v0.2 bash
</syntaxhighlight>

== Summary ==
This setup provides:
* Clean MediaWiki 1.44 installation
* Essential extensions (PageNotice, YouTube, SyntaxHighlight)
* Simple import/export via ~/wiki-container directory
* No automatic updates - full control over your content
* Easy backup and restore capabilities

The shared directory approach gives you complete control over when and what to import/export, making it ideal for:
* Migrating content between wikis
* Regular backups
* Sharing wiki content
* Testing imports before applying to production

CompleteNoobs Docker Image Creation

2025-09-02T10:53:40Z

AwesomO: /* Complete Noobs Docker Wiki Tutorial */

= Versions =
* This is version 0.1 - many bugs
* [[todo| CompleteNoobs Docker Image 0.2]]

= Complete Noobs Docker Wiki Tutorial =
* [[Docker_Install_Guide| Docker install guide]]
==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

* NOTE: The above <code>docker run</code> command is for quick testing, if you want to be able to export your wiki's database to an XML file you can backup and share, please use method in expanding info box below.
<div class="toccolours mw-collapsible mw-collapsed">
If you want to be able to Export Your MediaWiki Database to Dated XML File - use this <code>docker run</code> method:
<div class="mw-collapsible-content">

To export your MediaWiki database to a dated XML file (e.g., <code>20250901.xml</code>) and save it to the host’s <code>~/wiki-container</code> directory, run the export script inside the Docker container and use a volume mount to write the file to the host.<br><br>

<b>Step 1: Create Host Directory</b><br>
On the host, ensure the <code>~/wiki-container</code> directory exists:<br>
<syntaxhighlight lang="bash">
mkdir -p ~/wiki-container
</syntaxhighlight><br>

<b>Step 2: Run Container with Volume Mount</b><br>
If your container isn’t already using a volume for <code>~/wiki-container</code>, stop and remove it, then restart with a volume mount:<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.1
</syntaxhighlight><br>

<b>Step 3: Run Export Script in Container</b><br>
Access the container’s shell:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>
Inside the container, run the export script to create a dated XML file:<br>
<syntaxhighlight lang="bash">
DATE=$(date +%Y%m%d)
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:/export/$DATE.xml
exit
</syntaxhighlight>
This writes the file (e.g., <code>20250901.xml</code>) to <code>/export</code> in the container, which maps to <code>~/wiki-container</code> on the host.<br><br>

<b>Step 4: Verify the File</b><br>
On the host, check for the XML file:<br>
<syntaxhighlight lang="bash">
ls ~/wiki-container
</syntaxhighlight>
You should see a file like <code>20250901.xml</code>.<br><br>

<b>Notes</b><br>
- If you encounter permission issues, ensure the container’s user has write access to <code>/export</code>:<br>
<syntaxhighlight lang="bash">
chmod -R 777 /export
</syntaxhighlight>
- The script must be run inside the container, as it requires MediaWiki’s environment and database access.<br>
- If your container uses a different volume setup, adjust the mount point accordingly.

</div>
</div>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!
{{:Restore_the_completenoobs_Main_Page}}

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <nowiki><code><syntaxhighlight lang="python">code here</syntaxhighlight></code></nowiki>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

==need to add==
* way for user to backup there local custom wiki - xml exporter

Talk:Restore the completenoobs Main Page

2025-09-02T10:38:21Z

AwesomO: Created page with "* Enter in page - saves retyping <pre>{{:Restore_the_completenoobs_Main_Page}}</pre>"

* Enter in page - saves retyping
<pre>{{:Restore_the_completenoobs_Main_Page}}</pre>

CompleteNoobs Docker Image Creation

2025-09-02T10:23:46Z

AwesomO: /* 4.1: Check the Wiki */

= Complete Noobs Docker Wiki Tutorial =
* [[Docker_Install_Guide| Docker install guide]]
==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

* NOTE: The above <code>docker run</code> command is for quick testing, if you want to be able to export your wiki's database to an XML file you can backup and share, please use method in expanding info box below.
<div class="toccolours mw-collapsible mw-collapsed">
If you want to be able to Export Your MediaWiki Database to Dated XML File - use this <code>docker run</code> method:
<div class="mw-collapsible-content">

To export your MediaWiki database to a dated XML file (e.g., <code>20250901.xml</code>) and save it to the host’s <code>~/wiki-container</code> directory, run the export script inside the Docker container and use a volume mount to write the file to the host.<br><br>

<b>Step 1: Create Host Directory</b><br>
On the host, ensure the <code>~/wiki-container</code> directory exists:<br>
<syntaxhighlight lang="bash">
mkdir -p ~/wiki-container
</syntaxhighlight><br>

<b>Step 2: Run Container with Volume Mount</b><br>
If your container isn’t already using a volume for <code>~/wiki-container</code>, stop and remove it, then restart with a volume mount:<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.1
</syntaxhighlight><br>

<b>Step 3: Run Export Script in Container</b><br>
Access the container’s shell:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>
Inside the container, run the export script to create a dated XML file:<br>
<syntaxhighlight lang="bash">
DATE=$(date +%Y%m%d)
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:/export/$DATE.xml
exit
</syntaxhighlight>
This writes the file (e.g., <code>20250901.xml</code>) to <code>/export</code> in the container, which maps to <code>~/wiki-container</code> on the host.<br><br>

<b>Step 4: Verify the File</b><br>
On the host, check for the XML file:<br>
<syntaxhighlight lang="bash">
ls ~/wiki-container
</syntaxhighlight>
You should see a file like <code>20250901.xml</code>.<br><br>

<b>Notes</b><br>
- If you encounter permission issues, ensure the container’s user has write access to <code>/export</code>:<br>
<syntaxhighlight lang="bash">
chmod -R 777 /export
</syntaxhighlight>
- The script must be run inside the container, as it requires MediaWiki’s environment and database access.<br>
- If your container uses a different volume setup, adjust the mount point accordingly.

</div>
</div>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!
{{:Restore_the_completenoobs_Main_Page}}

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <nowiki><code><syntaxhighlight lang="python">code here</syntaxhighlight></code></nowiki>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

==need to add==
* way for user to backup there local custom wiki - xml exporter

Restore the completenoobs Main Page

2025-09-02T10:21:02Z

AwesomO: Created page with "<div class="toccolours mw-collapsible mw-collapsed"> Restore the completenoobs Main Page: <div class="mw-collapsible-content"> By default, the <code>completenoobs</code> MediaWiki instance overwrites the Main Page with content like "<strong>MediaWiki has been installed.</strong>" To revert to the page’s state before this change, undo the initial revision:<br><br> 1. Go to <code>http://localhost:8080</code> in your browser.<br> 2. On the Main Page, click <b>View Histo..."

<div class="toccolours mw-collapsible mw-collapsed">
Restore the completenoobs Main Page:
<div class="mw-collapsible-content">

By default, the <code>completenoobs</code> MediaWiki instance overwrites the Main Page with content like "<strong>MediaWiki has been installed.</strong>" To revert to the page’s state before this change, undo the initial revision:<br><br>

1. Go to <code>http://localhost:8080</code> in your browser.<br>
2. On the Main Page, click <b>View History</b> (top-right corner).<br>
3. Find the top revision by <code>MediaWiki default</code> and click <b>Undo</b>.<br>
4. Scroll down and click <b>Save changes</b> to revert the Main Page.<br><br>
</div>
</div>

Ubuntu2404 Install Docker and Docker Compose

2025-09-01T21:16:15Z

AwesomO: /* Install First Container/Image */

=== 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 && sudo apt upgrade -y
</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>



=== 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 ..

<div class="toccolours mw-collapsible mw-collapsed">
a way to apply group changes without logging out and back in - tip:
<div class="mw-collapsible-content">
<pre>
exec sudo su -l $USER
</pre>

This command will replace your current shell with a new login shell for your user, which will have the updated group memberships. Both of these methods will apply the group changes immediately, allowing you to use LXD commands without having to log out and back in.

<b>Remember</b>, these changes only apply to the current terminal session. If you open a new terminal window, you might need to run the command again or log out and back in for the changes to take effect system-wide.
</div>
</div>

===If Installing Docker messed up your LXC/LXD Networking===
To resolve networking conflicts between Docker and LXC containers on Ubuntu 24.04, enable IP forwarding on the host system:
* Open the sysctl configuration file in your preferred editor
<code>sudo $EDITOR /etc/sysctl.conf</code>
* Uncomment or add the following line (around line 28):
<pre>net.ipv4.ip_forward=1</pre>
* Apply the updated configuration to enable IP forwarding:
<code>sysctl -p</code><br>
* Restart the system to ensure all changes take effect.

This should resolve the networking issue for LXC containers when Docker is installed.

==Install First Container/Image==

Download the completenoobs container image, mediawiki with the completenoobs xml installed.

<code>docker pull completenoobs/cnoobs-wiki:0.1</code>

===Run container===

* Quick Start
<code>docker run -d -p 8080:80 completenoobs/cnoobs-wiki:0.1</code>

* Quick Start with Persistent Storage
<pre>
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.1
</pre>

* NOTE: The above <code>docker run</code> command is for quick testing, if you want to be able to export your wiki's database to an XML file you can backup and share, please use method in expanding info box below.
<div class="toccolours mw-collapsible mw-collapsed">
If you want to be able to Export Your MediaWiki Database to Dated XML File - use this <code>docker run</code> method:
<div class="mw-collapsible-content">

To export your MediaWiki database to a dated XML file (e.g., <code>20250901.xml</code>) and save it to the host’s <code>~/wiki-container</code> directory, run the export script inside the Docker container and use a volume mount to write the file to the host.<br><br>

<b>Step 1: Create Host Directory</b><br>
On the host, ensure the <code>~/wiki-container</code> directory exists:<br>
<syntaxhighlight lang="bash">
mkdir -p ~/wiki-container
</syntaxhighlight><br>

<b>Step 2: Run Container with Volume Mount</b><br>
If your container isn’t already using a volume for <code>~/wiki-container</code>, stop and remove it, then restart with a volume mount:<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.1
</syntaxhighlight><br>

<b>Step 3: Run Export Script in Container</b><br>
Access the container’s shell:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>
Inside the container, run the export script to create a dated XML file:<br>
<syntaxhighlight lang="bash">
DATE=$(date +%Y%m%d)
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:/export/$DATE.xml
exit
</syntaxhighlight>
This writes the file (e.g., <code>20250901.xml</code>) to <code>/export</code> in the container, which maps to <code>~/wiki-container</code> on the host.<br><br>

<b>Step 4: Verify the File</b><br>
On the host, check for the XML file:<br>
<syntaxhighlight lang="bash">
ls ~/wiki-container
</syntaxhighlight>
You should see a file like <code>20250901.xml</code>.<br><br>

<b>Notes</b><br>
- If you encounter permission issues, ensure the container’s user has write access to <code>/export</code>:<br>
<syntaxhighlight lang="bash">
chmod -R 777 /export
</syntaxhighlight>
- The script must be run inside the container, as it requires MediaWiki’s environment and database access.<br>
- If your container uses a different volume setup, adjust the mount point accordingly.

</div>
</div>
<div class="toccolours mw-collapsible mw-collapsed">
Import MediaWiki XML File from Host Directory:
<div class="mw-collapsible-content">

To import a <code>wiki.xml</code> file from the host’s <code>~/wiki-container</code> directory into your MediaWiki instance running in a Docker container, use the <code>importDump.php</code> script inside the container. The <code>~/wiki-container</code> directory is mounted as <code>/export</code> in the container, allowing the container to read the file.<br><br>

<b>Step 1: Place the XML File</b><br>
On the host, move or copy the <code>wiki.xml</code> file to <code>~/wiki-container</code>:<br>
<syntaxhighlight lang="bash">
mv ~/Downloads/wiki.xml ~/wiki-container/
</syntaxhighlight>
Verify the file is present:<br>
<syntaxhighlight lang="bash">
ls ~/wiki-container
</syntaxhighlight><br>

<b>Step 2: Access the Container’s Shell</b><br>
Enter the container’s shell:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight><br>

<b>Step 3: Run the Import Script</b><br>
Inside the container, import the <code>wiki.xml</code> file:<br>
Can check file is present in container with <code>ls /export/</code><br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php importDump.php /export/wiki.xml
</syntaxhighlight><br>
Note: This imports the XML content into the MediaWiki database. For large files, this may take time.<br><br>

<b>Step 4: Rebuild Wiki Indexes (Optional but Recommended)</b><br>
Rebuild the wiki’s indexes to ensure imported content is accessible:<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php rebuildall.php
</syntaxhighlight><br>

<b>Step 5: Exit the Container</b><br>
Exit the container’s shell:<br>
<syntaxhighlight lang="bash">
exit
</syntaxhighlight><br>

<b>Step 6: Verify the Import</b><br>
Visit your wiki (e.g., <code>http://localhost:8080</code>) to check if the imported pages appear. If issues arise, check the container logs:<br>
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight><br>

<b>Notes</b><br>
- Ensure the container has read access to <code>/export</code>. Fix permissions if needed:<br>
<syntaxhighlight lang="bash">
chmod -R 777 /export
</syntaxhighlight>
- If you want to overwrite existing pages, use the <code>--no-updates</code> flag with <code>importDump.php</code>.<br>
- If the container wasn’t started with <code>~/wiki-container</code> mounted as <code>/export</code>, restart it with:<br>
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 -v ~/wiki-container:/export --name completenoobs_wiki completenoobs/cnoobs-wiki:0.1
</syntaxhighlight>

</div>
</div>

* Now visit http://localhost:8080 on your browser

* Due to (unknown) bug you might need to update the xml to download missing pages:
<code>docker exec -it completenoobs_wiki /var/www/html/check_updates.sh</code>

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

===Remove container===

To completely remove the <code>completenoobs/cnoobs-wiki:0.1</code> container and image from your Ubuntu 24.04 system, follow these steps. You can also remove associated persistent storage volumes if they were created.<br><br>

<b>Step 1: Stop and Remove the Container</b><br>
If the container is running, stop it and then remove it.<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
</syntaxhighlight>
Alternatively, stop and remove in one command:<br>
<syntaxhighlight lang="bash">
docker rm -f completenoobs_wiki
</syntaxhighlight><br>

<b>Step 2: Remove the Docker Image</b><br>
Remove the <code>completenoobs/cnoobs-wiki:0.1</code> image.<br>
<syntaxhighlight lang="bash">
docker rmi completenoobs/cnoobs-wiki:0.1
</syntaxhighlight>
Note: If the image is in use by other containers, remove those containers first or use <code>docker rmi -f completenoobs/cnoobs-wiki:0.1</code> to force removal (use with caution).<br><br>

<b>Step 3: Remove Persistent Storage Volumes (Optional)</b><br>
If you used persistent storage, remove the associated volumes to free up space.<br>
<syntaxhighlight lang="bash">
docker volume rm completenoobs_mysql completenoobs_images
</syntaxhighlight>
Note: Ensure no other containers are using these volumes, as this will delete all stored data.<br><br>

<b>Step 4: Verify Removal</b><br>
Check that the container, image, and volumes are removed.<br>
- List all containers (including stopped ones):<br>
<syntaxhighlight lang="bash">
docker ps -a
</syntaxhighlight>
- List all images:<br>
<syntaxhighlight lang="bash">
docker images
</syntaxhighlight>
- List all volumes:<br>
<syntaxhighlight lang="bash">
docker volume ls
</syntaxhighlight>
If any items remain, repeat the relevant removal commands or check for dependencies.

==Docker Compose container==

Ubuntu2404 Install Docker and Docker Compose

2025-09-01T21:13:29Z

AwesomO: /* Run container */

CompleteNoobs Docker Image Creation

2025-09-01T20:52:16Z

AwesomO: /* 3.2: Run the Container */

= Complete Noobs Docker Wiki Tutorial =
* [[Docker_Install_Guide| Docker install guide]]
==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

* NOTE: The above <code>docker run</code> command is for quick testing, if you want to be able to export your wiki's database to an XML file you can backup and share, please use method in expanding info box below.
<div class="toccolours mw-collapsible mw-collapsed">
If you want to be able to Export Your MediaWiki Database to Dated XML File - use this <code>docker run</code> method:
<div class="mw-collapsible-content">

To export your MediaWiki database to a dated XML file (e.g., <code>20250901.xml</code>) and save it to the host’s <code>~/wiki-container</code> directory, run the export script inside the Docker container and use a volume mount to write the file to the host.<br><br>

<b>Step 1: Create Host Directory</b><br>
On the host, ensure the <code>~/wiki-container</code> directory exists:<br>
<syntaxhighlight lang="bash">
mkdir -p ~/wiki-container
</syntaxhighlight><br>

<b>Step 2: Run Container with Volume Mount</b><br>
If your container isn’t already using a volume for <code>~/wiki-container</code>, stop and remove it, then restart with a volume mount:<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.1
</syntaxhighlight><br>

<b>Step 3: Run Export Script in Container</b><br>
Access the container’s shell:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>
Inside the container, run the export script to create a dated XML file:<br>
<syntaxhighlight lang="bash">
DATE=$(date +%Y%m%d)
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:/export/$DATE.xml
exit
</syntaxhighlight>
This writes the file (e.g., <code>20250901.xml</code>) to <code>/export</code> in the container, which maps to <code>~/wiki-container</code> on the host.<br><br>

<b>Step 4: Verify the File</b><br>
On the host, check for the XML file:<br>
<syntaxhighlight lang="bash">
ls ~/wiki-container
</syntaxhighlight>
You should see a file like <code>20250901.xml</code>.<br><br>

<b>Notes</b><br>
- If you encounter permission issues, ensure the container’s user has write access to <code>/export</code>:<br>
<syntaxhighlight lang="bash">
chmod -R 777 /export
</syntaxhighlight>
- The script must be run inside the container, as it requires MediaWiki’s environment and database access.<br>
- If your container uses a different volume setup, adjust the mount point accordingly.

</div>
</div>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <nowiki><code><syntaxhighlight lang="python">code here</syntaxhighlight></code></nowiki>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

==need to add==
* way for user to backup there local custom wiki - xml exporter

Ubuntu2404 Install Docker and Docker Compose

2025-09-01T20:50:32Z

AwesomO: /* Run container */

=== 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 && sudo apt upgrade -y
</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>



=== 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 ..

<div class="toccolours mw-collapsible mw-collapsed">
a way to apply group changes without logging out and back in - tip:
<div class="mw-collapsible-content">
<pre>
exec sudo su -l $USER
</pre>

This command will replace your current shell with a new login shell for your user, which will have the updated group memberships. Both of these methods will apply the group changes immediately, allowing you to use LXD commands without having to log out and back in.

<b>Remember</b>, these changes only apply to the current terminal session. If you open a new terminal window, you might need to run the command again or log out and back in for the changes to take effect system-wide.
</div>
</div>

===If Installing Docker messed up your LXC/LXD Networking===
To resolve networking conflicts between Docker and LXC containers on Ubuntu 24.04, enable IP forwarding on the host system:
* Open the sysctl configuration file in your preferred editor
<code>sudo $EDITOR /etc/sysctl.conf</code>
* Uncomment or add the following line (around line 28):
<pre>net.ipv4.ip_forward=1</pre>
* Apply the updated configuration to enable IP forwarding:
<code>sysctl -p</code><br>
* Restart the system to ensure all changes take effect.

This should resolve the networking issue for LXC containers when Docker is installed.

==Install First Container/Image==

Download the completenoobs container image, mediawiki with the completenoobs xml installed.

<code>docker pull completenoobs/cnoobs-wiki:0.1</code>

===Run container===

* Quick Start
<code>docker run -d -p 8080:80 completenoobs/cnoobs-wiki:0.1</code>

* Quick Start with Persistent Storage
<pre>
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.1
</pre>

* NOTE: The above <code>docker run</code> command is for quick testing, if you want to be able to export your wiki's database to an XML file you can backup and share, please use method in expanding info box below.
<div class="toccolours mw-collapsible mw-collapsed">
If you want to be able to Export Your MediaWiki Database to Dated XML File - use this <code>docker run</code> method:
<div class="mw-collapsible-content">

To export your MediaWiki database to a dated XML file (e.g., <code>20250901.xml</code>) and save it to the host’s <code>~/wiki-container</code> directory, run the export script inside the Docker container and use a volume mount to write the file to the host.<br><br>

<b>Step 1: Create Host Directory</b><br>
On the host, ensure the <code>~/wiki-container</code> directory exists:<br>
<syntaxhighlight lang="bash">
mkdir -p ~/wiki-container
</syntaxhighlight><br>

<b>Step 2: Run Container with Volume Mount</b><br>
If your container isn’t already using a volume for <code>~/wiki-container</code>, stop and remove it, then restart with a volume mount:<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v ~/wiki-container:/export \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:0.1
</syntaxhighlight><br>

<b>Step 3: Run Export Script in Container</b><br>
Access the container’s shell:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>
Inside the container, run the export script to create a dated XML file:<br>
<syntaxhighlight lang="bash">
DATE=$(date +%Y%m%d)
php /var/www/html/maintenance/run.php dumpBackup.php --full --output=file:/export/$DATE.xml
exit
</syntaxhighlight>
This writes the file (e.g., <code>20250901.xml</code>) to <code>/export</code> in the container, which maps to <code>~/wiki-container</code> on the host.<br><br>

<b>Step 4: Verify the File</b><br>
On the host, check for the XML file:<br>
<syntaxhighlight lang="bash">
ls ~/wiki-container
</syntaxhighlight>
You should see a file like <code>20250901.xml</code>.<br><br>

<b>Notes</b><br>
- If you encounter permission issues, ensure the container’s user has write access to <code>/export</code>:<br>
<syntaxhighlight lang="bash">
chmod -R 777 /export
</syntaxhighlight>
- The script must be run inside the container, as it requires MediaWiki’s environment and database access.<br>
- If your container uses a different volume setup, adjust the mount point accordingly.

</div>
</div>

* Now visit http://localhost:8080 on your browser

* Due to (unknown) bug you might need to update the xml to download missing pages:
<code>docker exec -it completenoobs_wiki /var/www/html/check_updates.sh</code>

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

===Remove container===

To completely remove the <code>completenoobs/cnoobs-wiki:0.1</code> container and image from your Ubuntu 24.04 system, follow these steps. You can also remove associated persistent storage volumes if they were created.<br><br>

<b>Step 1: Stop and Remove the Container</b><br>
If the container is running, stop it and then remove it.<br>
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
</syntaxhighlight>
Alternatively, stop and remove in one command:<br>
<syntaxhighlight lang="bash">
docker rm -f completenoobs_wiki
</syntaxhighlight><br>

<b>Step 2: Remove the Docker Image</b><br>
Remove the <code>completenoobs/cnoobs-wiki:0.1</code> image.<br>
<syntaxhighlight lang="bash">
docker rmi completenoobs/cnoobs-wiki:0.1
</syntaxhighlight>
Note: If the image is in use by other containers, remove those containers first or use <code>docker rmi -f completenoobs/cnoobs-wiki:0.1</code> to force removal (use with caution).<br><br>

<b>Step 3: Remove Persistent Storage Volumes (Optional)</b><br>
If you used persistent storage, remove the associated volumes to free up space.<br>
<syntaxhighlight lang="bash">
docker volume rm completenoobs_mysql completenoobs_images
</syntaxhighlight>
Note: Ensure no other containers are using these volumes, as this will delete all stored data.<br><br>

<b>Step 4: Verify Removal</b><br>
Check that the container, image, and volumes are removed.<br>
- List all containers (including stopped ones):<br>
<syntaxhighlight lang="bash">
docker ps -a
</syntaxhighlight>
- List all images:<br>
<syntaxhighlight lang="bash">
docker images
</syntaxhighlight>
- List all volumes:<br>
<syntaxhighlight lang="bash">
docker volume ls
</syntaxhighlight>
If any items remain, repeat the relevant removal commands or check for dependencies.

Docker Mediawiki Local Install

2025-09-01T20:35:47Z

AwesomO: /* Step 2: Create a Docker Compose File */

= Setting Up a Plain MediaWiki Instance with Docker on Ubuntu 24.04 =

This guide provides a simple, step-by-step process to set up a basic MediaWiki instance locally using Docker and Docker Compose on Ubuntu 24.04.

It is designed for beginners and assumes you have Docker and Docker Compose installed (see [[Docker_Install_Guide]] for setup details).

The setup includes MediaWiki with a MariaDB database, running in Docker containers.

== Prerequisites ==
* Ubuntu 24.04
* Docker and Docker Compose installed
* Basic familiarity with terminal commands
* Internet connection for pulling Docker images

== Step 1: Create a Project Directory ==
Create a dedicated directory to organize your MediaWiki setup files.
<br>
<code>mkdir mediawiki-docker</code><br>
<code>cd mediawiki-docker</code>

== Step 2: Create a Docker Compose File ==
Create a '''docker-compose.yml''' file to define the MediaWiki and MariaDB services.

<code>nano docker-compose.yml</code>

Paste the following configuration into <code>docker-compose.yml</code>:

<pre>
version: '3.8'
services:
mediawiki:
image: mediawiki:1.41
ports:
- "8080:80"
depends_on:
database:
condition: service_healthy
volumes: # will uncomment line below after init setup of wiki
# - ./LocalSettings.php:/var/www/html/LocalSettings.php:ro
environment:
- MEDIAWIKI_DB_HOST=database
- MEDIAWIKI_DB_USER=wikiuser
- MEDIAWIKI_DB_PASSWORD=securepassword
- MEDIAWIKI_DB_NAME=mediawiki
database:
image: mariadb:10.11
environment:
- MARIADB_ROOT_PASSWORD=securepassword
- MARIADB_DATABASE=mediawiki
- MARIADB_USER=wikiuser
- MARIADB_PASSWORD=securepassword
- MARIADB_AUTO_UPGRADE=1
volumes:
- db_data:/var/lib/mysql
healthcheck:
test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
interval: 10s
timeout: 5s
retries: 5
mem_limit: 512m
volumes:
db_data:

</pre>

Save and exit (`Ctrl+O`, `Enter`, `Ctrl+X`).

'''Explanation:'''
* The mediawiki service uses MediaWiki 1.41 for stability.
* `database` service uses the MariaDB image for the database.
* Port `8080` maps to MediaWiki's web server port `80`.
* Environment variables set up the database connection.
* A volume persists MariaDB data.
* `LocalSettings.php` will be mounted later after setup.

== Step 3: Start the Containers ==
Run the following command to start the MediaWiki and MariaDB containers:

<code>docker-compose up -d</code>

* `-d` runs containers in the background.
* This pulls the MediaWiki and MariaDB images and starts the services.

== Step 4: Verify Containers Are Running ==
Check that both containers are running:

<code>docker ps</code>

You should see two containers: one for `mediawiki` and one for `mariadb`.

== Step 5: Access the MediaWiki Setup Page ==
Open a web browser and navigate to:

http://localhost:8080

You should see the MediaWiki setup page. If not, ensure containers are running and port `8080` is not blocked.

== Step 6: Complete the MediaWiki Web Installer ==
Follow the on-screen instructions in the browser:
* Select your language and click "Continue."
* Accept the defaults for database settings, these details can be found in your '''docker-compose.yml''' file.
** host: '''database''' - change from default '''localhost'''
** user: '''wikiuser''' - change from default '''root'''
** password: '''securepassword'''
** database name: '''mediawiki''' - change from default '''my_wiki'''
* Set up an admin user and password for your wiki.
* Complete the installation. At the end, MediaWiki generates a '''LocalSettings.php''' file.

== Step 7: Download and Place LocalSettings.php ==
The installer prompts you to download `LocalSettings.php`. Save it to your `mediawiki-docker` directory:

<code>mv ~/Downloads/LocalSettings.php ~/mediawiki-docker/</code>

Ensure the file is named exactly '''LocalSettings.php'''.<br>
The Docker Compose configuration mounts this file into the MediaWiki container.

== Step 8: Restart Containers ==
Restart the containers to apply '''LocalSettings.php''':

* Turn off container
<code>docker-compose down</code>

* Edit '''docker-compose.yml''' and uncomment the lines
<pre>
# volumes: # will uncomment these 2 lines after init setup of wiki
# - ./LocalSettings.php:/var/www/html/LocalSettings.php:ro
</pre>

<pre>
version: '3.8'
services:
mediawiki:
image: mediawiki:1.41
ports:
- "8080:80"
depends_on:
database:
condition: service_healthy
volumes: # will uncomment these 2 lines after init setup of wiki
- ./LocalSettings.php:/var/www/html/LocalSettings.php:ro
environment:
- MEDIAWIKI_DB_HOST=database
- MEDIAWIKI_DB_USER=wikiuser
- MEDIAWIKI_DB_PASSWORD=securepassword
- MEDIAWIKI_DB_NAME=mediawiki
database:
image: mariadb:10.11
environment:
- MARIADB_ROOT_PASSWORD=securepassword
- MARIADB_DATABASE=mediawiki
- MARIADB_USER=wikiuser
- MARIADB_PASSWORD=securepassword
- MARIADB_AUTO_UPGRADE=1
volumes:
- db_data:/var/lib/mysql
healthcheck:
test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
interval: 10s
timeout: 5s
retries: 5
mem_limit: 512m
volumes:
db_data:

</pre>

* start container
<code>docker-compose up -d</code>

== Step 9: Access Your Wiki ==
Visit `http://localhost:8080` again. You should now see your MediaWiki instance. Log in with the admin credentials you set during installation.

== Step 10: Basic Usage ==
* Create and edit pages using the MediaWiki interface.
* Access the wiki at `http://localhost:8080`.
* Manage users and settings via the admin account.

== Stopping and Removing Containers ==
To stop the containers:

<code>docker-compose stop</code>

To stop and remove containers (data persists in the `db_data` volume):

<code>docker-compose down</code>

To remove all data (including the database), also delete the volume:

<code>docker-compose down -v</code>

== 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 (~/mediawiki-docker/LocalSettings.php). 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:
* Default - around line 33
<source lang="php">
## The protocol and server name to use in fully-qualified URLs
$wgServer = 'http://127.0.0.1:8080';
</source>
*Changed
<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.

== Troubleshooting ==
* '''Cannot access localhost:8080''': Check `docker ps` to ensure containers are running. Verify port `8080` is not used by another service (`sudo netstat -tuln | grep 8080`).
* '''Database connection error''': Ensure environment variables in `docker-compose.yml` match the installer settings.
* '''LocalSettings.php not found''': Confirm the file is in the `mediawiki-docker` directory and named correctly.

== Notes ==
* The database data is stored in a Docker volume (`db_data`) and persists between container restarts.
* To customize MediaWiki, edit `LocalSettings.php` and restart containers.
* For production, secure `MYSQL_ROOT_PASSWORD` and `MEDIAWIKI_DB_PASSWORD` with stronger values.

== References ==
* [[Docker_Install_Guide]]
* [https://hub.docker.com/_/mediawiki Official MediaWiki Docker Image]
* [https://hub.docker.com/_/mariadb Official MariaDB Docker Image]
* [https://www.mediawiki.org/wiki/Manual:Installing_MediaWiki MediaWiki Installation Guide]

CompleteNoobs Docker Image Creation

2025-09-01T20:20:28Z

AwesomO: /* Expected Results */

= Complete Noobs Docker Wiki Tutorial =
* [[Docker_Install_Guide| Docker install guide]]
==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <nowiki><code><syntaxhighlight lang="python">code here</syntaxhighlight></code></nowiki>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

==need to add==
* way for user to backup there local custom wiki - xml exporter

CompleteNoobs Docker Image Creation

2025-09-01T20:04:48Z

AwesomO: /* Important Notes */

= Complete Noobs Docker Wiki Tutorial =
* [[Docker_Install_Guide| Docker install guide]]
==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <nowiki><code><syntaxhighlight lang="python">code here</syntaxhighlight></code></nowiki>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

CompleteNoobs Docker Image Creation

2025-09-01T20:04:02Z

AwesomO: /* Update System Features */

= Complete Noobs Docker Wiki Tutorial =
* [[Docker_Install_Guide| Docker install guide]]
==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <nowiki><code><syntaxhighlight lang="python">code here</syntaxhighlight></code></nowiki>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

== Important Notes ==
* First Import: Initial build imports ALL content from XML
* Subsequent Updates: Only import NEW pages, preserving your edits
* Conflict Resolution: To force-update a specific page with XML version, delete it first through wiki interface
* Backups: Stored in /tmp/ (cleared on container restart)

CompleteNoobs Docker Image Creation

2025-09-01T20:00:59Z

AwesomO: /* Step 1: Clean Start */

= Complete Noobs Docker Wiki Tutorial =
* [[Docker_Install_Guide| Docker install guide]]
==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <nowiki><code><syntaxhighlight lang="python">code here</syntaxhighlight></code></nowiki>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

== Update System Features ==

=== How Updates Work ===
# Version Tracking: System tracks which XML dump version you have
# Smart Import: Only imports pages that don't exist locally
# Edit Preservation: Never overwrites pages you've edited
# Automatic Backup: Creates SQL backup before any updates
# User Confirmation: Asks before making changes
# Progress Feedback: Shows what's being imported/skipped

== Important Notes ==
* First Import: Initial build imports ALL content from XML
* Subsequent Updates: Only import NEW pages, preserving your edits
* Conflict Resolution: To force-update a specific page with XML version, delete it first through wiki interface
* Backups: Stored in /tmp/ (cleared on container restart)

CompleteNoobs Local Wiki In Docker

2025-09-01T19:13:31Z

AwesomO: /* Starting Environment */

==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.]]

==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 ==

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

=== 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 ..

<div class="toccolours mw-collapsible mw-collapsed">
a way to apply group changes without logging out and back in - tip:
<div class="mw-collapsible-content">
<pre>
exec sudo su -l $USER
</pre>

This command will replace your current shell with a new login shell for your user, which will have the updated group memberships. Both of these methods will apply the group changes immediately, allowing you to use LXD commands without having to log out and back in. Remember, these changes only apply to the current terminal session. If you open a new terminal window, you might need to run the command again or log out and back in for the changes to take effect system-wide.
</div>
</div>

= 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>
<div class="toccolours mw-collapsible mw-collapsed">
Newer Script that will list newest first - list from new to old in order:
<div class="mw-collapsible-content">
* Passed early testing
<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 parse_date_from_dump(dump_name):
"""Parse DD_MM_YY format and return a sortable date tuple."""
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
# Convert 2-digit year to 4-digit (assuming 00-49 = 2000-2049, 50-99 = 1950-1999)
year_int = int(year)
if year_int <= 49:
full_year = 2000 + year_int
else:
full_year = 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0) # fallback for unparseable names

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('/'))

# Sort by actual date (newest first)
return sorted(dumps, key=parse_date_from_dump, 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'):
# Extract file info (size, date) from the next sibling text
file_info = ""
next_sibling = link.next_sibling
if next_sibling:
file_info = next_sibling.strip()
files[href] = file_info

# Sort XML files by name (newest first, assuming filename contains date/time info)
sorted_files = dict(sorted(files.items(), key=lambda x: x[0], reverse=True))
return sorted_files

def download_file(url, filename):
print(f"Downloading from: {url}")
response = requests.get(url, stream=True)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print() # New line after progress

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 check_docker_permissions():
"""Check if Docker is accessible and provide helpful error messages."""
try:
output, error, return_code = run_command("docker info")
if return_code != 0:
if "permission denied" in error.lower():
print("ERROR: Docker permission denied!")
print("Solutions:")
print("1. Run this script with sudo: sudo python3 setup_and_import.py")
print("2. Or add your user to docker group: sudo usermod -aG docker $USER")
print(" Then log out and log back in.")
return False
else:
print(f"Docker error: {error}")
return False
return True
except Exception as e:
print(f"Error checking Docker: {e}")
return False

def setup_mediawiki():
print("Checking Docker permissions...")
if not check_docker_permissions():
sys.exit(1)

print("Setting up MediaWiki...")
output, error, return_code = run_command("docker-compose up -d")
if return_code != 0:
print(f"Error starting Docker containers: {error}")
sys.exit(1)

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)

output, error, return_code = run_command("docker-compose restart mediawiki")
if return_code != 0:
print(f"Error restarting MediaWiki: {error}")
sys.exit(1)

print("MediaWiki setup completed.")

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

def main():
# Check Docker permissions early
if not os.path.exists('LocalSettings.php'):
setup_mediawiki()
else:
# Even if LocalSettings.php exists, check Docker permissions for import
print("Checking Docker permissions...")
if not check_docker_permissions():
sys.exit(1)

print("Fetching available dumps...")
dumps = get_available_dumps()
if not dumps:
print("No dumps found!")
sys.exit(1)

print("\nAvailable dumps (newest first):")
for i, dump in enumerate(dumps):
marker = " (NEWEST)" if i == 0 else ""
print(f"{i + 1}. {dump}{marker}")

# Default to newest dump (index 0)
default_choice = 1
choice_input = input(f"\nEnter the number of the dump you want to download (default: {default_choice} - newest): ").strip()

if choice_input == "":
choice = default_choice - 1
else:
try:
choice = int(choice_input) - 1
if choice < 0 or choice >= len(dumps):
print("Invalid choice. Using newest dump.")
choice = 0
except ValueError:
print("Invalid input. Using newest dump.")
choice = 0

selected_dump = dumps[choice]
print(f"\nSelected dump: {selected_dump}")

print("Fetching XML files from selected dump...")
files = get_dump_files(selected_dump)

if not files:
print("No XML files found in the selected dump!")
sys.exit(1)

xml_files = list(files.keys())

print(f"\nAvailable XML files in {selected_dump} (newest first):")
for i, xml_file in enumerate(xml_files):
file_info = files[xml_file]
marker = " (RECOMMENDED)" if i == 0 else ""
print(f"{i + 1}. {xml_file}{marker}")
if file_info:
print(f" {file_info}")

# Default to newest XML file (index 0)
default_xml_choice = 1
xml_choice_input = input(f"\nEnter the number of the XML file you want to download (default: {default_xml_choice} - newest): ").strip()

if xml_choice_input == "":
xml_choice = default_xml_choice - 1
else:
try:
xml_choice = int(xml_choice_input) - 1
if xml_choice < 0 or xml_choice >= len(xml_files):
print("Invalid choice. Using newest XML file.")
xml_choice = 0
except ValueError:
print("Invalid input. Using newest XML file.")
xml_choice = 0

selected_xml = xml_files[xml_choice]
print(f"\nSelected XML file: {selected_xml}")

# Check if file already exists
if os.path.exists(selected_xml):
overwrite = input(f"\n{selected_xml} already exists. Overwrite? (y/N): ").strip().lower()
if overwrite not in ['y', 'yes']:
print("Using existing file.")
else:
print(f"Downloading {selected_xml}...")
download_file(BASE_URL + selected_dump + '/' + selected_xml, selected_xml)
else:
print(f"Downloading {selected_xml}...")
download_file(BASE_URL + selected_dump + '/' + selected_xml, selected_xml)

print("Importing XML dump into MediaWiki...")
import_xml_to_mediawiki(selected_xml)
print("\nImport completed successfully!")
print(f"Your MediaWiki instance should now be available at: http://localhost:8080")

if __name__ == "__main__":
main()
</source>
</div>
</div>
'''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 <container_name_and_service>-1 /bin/bash</code>
** use:<code>docker container ls</code> or <code>docker ps</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.

Main Page

2025-09-01T18:37:56Z

AwesomO: /* CompleteNoobs: A Downloadable Wiki for Reproducible Computer Tutorials */

=In Concept development Mode - a wiki you can download=
= CompleteNoobs: A Downloadable Wiki for Reproducible Computer Tutorials =

'''CompleteNoobs''' is a open-source wiki offering free, reproducible computer science tutorials.

* [[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.]]

== About CompleteNoobs ==

Our mission is to provide accessible, libre-licensed resources for hobbyists, sysadmins, students, teachers, and computer science enthusiasts. All content is available under a '''Creative Commons BY-NC-SA''' license, ensuring the freedoms to:
* Read
* Edit/Modify
* Copy
* Share freely

Download the wiki as an XML file at [https://xml.completenoobs.com xml.completenoobs.com] or access data-heavy content (images, videos, audio) via '''IPFS''' hashes.

== Get Started ==

* '''Download the Wiki''': Run CompleteNoobs locally using our [[Local_CompleteNoobs_Wiki|Manually install guides or Docker image]].
* '''Host Your Own''': Set up your own MediaWiki instance with our guide: [[Host_Your_Own_Mediawiki_Online|Host Your Own MediaWiki Online]].

== CompleteNoobs Blockchain Project ==

As Noobs we want to learn more about bitcoin, without losing any real bitcoin

First we are learning how to fork bitcoin version 0.14.3, best way to learn is by tinkering with it.
* [[N33Bcoin| n33b.com]]

== Essential Links ==

* [[Main_Index|Main Index Page]]
* [[Special:AllPages|All Pages]]
* [[Wiki_Basic_Syntax|Wiki Basic Syntax]]
* [[COMPLETENOOBS_FUNDING|Support Us]]

== Licenses ==

All content is libre-licensed for free copying, modification, and distribution. Add a license header to your contributions using:
<pre>{{:LICENCE_HEADER_CC0}}</pre>
{{:LICENCE_HEADER_CC0}}

== Disclaimer ==

<div class="toccolours mw-collapsible mw-collapsed">
'''''DISCLAIMER:'''''
<div class="mw-collapsible-content">
Content on CompleteNoobs is for informational and educational purposes only. We make no warranties about accuracy or reliability. Use at your own risk. Links to external sites are not endorsements, and we are not responsible for their content or availability. The site may be temporarily unavailable due to technical issues beyond our control.
</div>
</div>

{{Special:ContributionScores/10/5}}
{{Special:PopularPages/10}}

Main Page

2025-09-01T18:00:22Z

AwesomO: /* Get Started */

=In Concept development Mode - a wiki you can download=
= CompleteNoobs: A Downloadable Wiki for Reproducible Computer Tutorials =

'''CompleteNoobs''' is a open-source wiki offering free, reproducible computer science tutorials.

* [[https://www.completenoobs.com/noobs/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.]]

== About CompleteNoobs ==

Our mission is to provide accessible, libre-licensed resources for hobbyists, sysadmins, students, teachers, and computer science enthusiasts. All content is available under a '''Creative Commons BY-NC-SA''' license, ensuring the freedoms to:
* Read
* Edit/Modify
* Copy
* Share freely

Download the wiki as an XML file at [https://xml.completenoobs.com xml.completenoobs.com] or access data-heavy content (images, videos, audio) via '''IPFS''' hashes.

== Get Started ==

* '''Download the Wiki''': Run CompleteNoobs locally using our [[Local_CompleteNoobs_Wiki|Manually install guides or Docker image]].
* '''Host Your Own''': Set up your own MediaWiki instance with our guide: [[Host_Your_Own_Mediawiki_Online|Host Your Own MediaWiki Online]].

== CompleteNoobs Blockchain Project ==

As Noobs we want to learn more about bitcoin, without losing any real bitcoin

First we are learning how to fork bitcoin version 0.14.3, best way to learn is by tinkering with it.
* [[N33Bcoin| n33b.com]]

== Essential Links ==

* [[Main_Index|Main Index Page]]
* [[Special:AllPages|All Pages]]
* [[Wiki_Basic_Syntax|Wiki Basic Syntax]]
* [[COMPLETENOOBS_FUNDING|Support Us]]

== Licenses ==

All content is libre-licensed for free copying, modification, and distribution. Add a license header to your contributions using:
<pre>{{:LICENCE_HEADER_CC0}}</pre>
{{:LICENCE_HEADER_CC0}}

== Disclaimer ==

<div class="toccolours mw-collapsible mw-collapsed">
'''''DISCLAIMER:'''''
<div class="mw-collapsible-content">
Content on CompleteNoobs is for informational and educational purposes only. We make no warranties about accuracy or reliability. Use at your own risk. Links to external sites are not endorsements, and we are not responsible for their content or availability. The site may be temporarily unavailable due to technical issues beyond our control.
</div>
</div>

{{Special:ContributionScores/10/5}}
{{Special:PopularPages/10}}

Main Page

2025-09-01T17:59:32Z

AwesomO:

=In Concept development Mode - a wiki you can download=
= CompleteNoobs: A Downloadable Wiki for Reproducible Computer Tutorials =

'''CompleteNoobs''' is a open-source wiki offering free, reproducible computer science tutorials.

* [[https://www.completenoobs.com/noobs/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.]]

== About CompleteNoobs ==

Our mission is to provide accessible, libre-licensed resources for hobbyists, sysadmins, students, teachers, and computer science enthusiasts. All content is available under a '''Creative Commons BY-NC-SA''' license, ensuring the freedoms to:
* Read
* Edit/Modify
* Copy
* Share freely

Download the wiki as an XML file at [https://xml.completenoobs.com xml.completenoobs.com] or access data-heavy content (images, videos, audio) via '''IPFS''' hashes.

== Get Started ==

* '''Download the Wiki''': Run CompleteNoobs locally using our [[/Local_CompleteNoobs_Wiki|Manually install guides or Docker image]].
* '''Host Your Own''': Set up your own MediaWiki instance with our guide: [[Host_Your_Own_Mediawiki_Online|Host Your Own MediaWiki Online]].

== CompleteNoobs Blockchain Project ==

As Noobs we want to learn more about bitcoin, without losing any real bitcoin

First we are learning how to fork bitcoin version 0.14.3, best way to learn is by tinkering with it.
* [[N33Bcoin| n33b.com]]

== Essential Links ==

* [[Main_Index|Main Index Page]]
* [[Special:AllPages|All Pages]]
* [[Wiki_Basic_Syntax|Wiki Basic Syntax]]
* [[COMPLETENOOBS_FUNDING|Support Us]]

== Licenses ==

All content is libre-licensed for free copying, modification, and distribution. Add a license header to your contributions using:
<pre>{{:LICENCE_HEADER_CC0}}</pre>
{{:LICENCE_HEADER_CC0}}

== Disclaimer ==

<div class="toccolours mw-collapsible mw-collapsed">
'''''DISCLAIMER:'''''
<div class="mw-collapsible-content">
Content on CompleteNoobs is for informational and educational purposes only. We make no warranties about accuracy or reliability. Use at your own risk. Links to external sites are not endorsements, and we are not responsible for their content or availability. The site may be temporarily unavailable due to technical issues beyond our control.
</div>
</div>

{{Special:ContributionScores/10/5}}
{{Special:PopularPages/10}}

Local CompleteNoobs Wiki

2025-09-01T17:55:51Z

AwesomO:

CompleteNoobs Wiki [[Nginx_Server_For_Hosting_Files_Ubuntu_22.04|XML Dumps]] can be found at <nowiki>https://xml.completenoobs.com</nowiki>

[[Ubuntu_Local_Wiki_Import | Ubuntu Import Wiki to Local]]

[[Windows_10_Local_Wiki_Import | Windows 10 Import Local Wiki]]

[[FreeBSD_13.2_Jail_Local_Mediawiki_Nginx_MySQL | FreeBSD Jail]]

[[CompleteNoobs_Local_Wiki_In_Docker | Docker ]]

[[Ubuntu2404_Install_Docker_and_Docker_Compose| Download are Docker Image]]

[[Docker_Mediawiki_Local_Install| vanilla mediawiki docker install]]

Docker Image Sharing - Export Import

2025-09-01T17:41:45Z

AwesomO: Created page with "= Upload Your Docker Image to Docker Hub on Ubuntu 24.04 - Complete Beginner's Guide = This tutorial will walk you through uploading your first Docker image to Docker Hub, making it available for anyone to download and run. We'll use the CompleteNoobs Wiki image as our example. == What is Docker Hub? == Docker Hub is like GitHub but for Docker images. It's a cloud-based registry where you can: * Store your Docker images publicly (free) or privately (paid) * Share conta..."

= Upload Your Docker Image to Docker Hub on Ubuntu 24.04 - Complete Beginner's Guide =

This tutorial will walk you through uploading your first Docker image to Docker Hub, making it available for anyone to download and run. We'll use the CompleteNoobs Wiki image as our example.

== What is Docker Hub? ==
Docker Hub is like GitHub but for Docker images. It's a cloud-based registry where you can:
* Store your Docker images publicly (free) or privately (paid)
* Share containers with the community
* Download images others have created
* Automate builds from GitHub repositories

== Prerequisites ==
* Ubuntu 24.04 with Docker installed
* A working Docker image (we'll use completenoobs/wiki:latest from the previous tutorial)
* Internet connection
* Email address for Docker Hub account

== Step 1: Create Docker Hub Account ==

=== 1.1: Sign Up ===
# Open your web browser
# Navigate to: https://hub.docker.com
# Click '''Sign Up''' button (top right)
# Fill in the registration form:
#* '''Docker ID''': Choose a unique username (e.g., "yourname" or "completenoobs")
#* '''Email''': Your email address
#* '''Password''': Strong password (mix of letters, numbers, symbols)
# Complete the CAPTCHA
# Click '''Sign Up'''
# Verify your email (check inbox for Docker confirmation email)

'''Important''': Your Docker ID becomes part of your image name (e.g., yourname/wiki:latest)

=== 1.2: Sign In to Docker Hub ===
# Return to https://hub.docker.com
# Click '''Sign In'''
# Enter your Docker ID and password
# You'll see your Docker Hub dashboard

== Step 2: Create Repository on Docker Hub ==

=== 2.1: Create New Repository ===
# On Docker Hub dashboard, click '''Create Repository'''
# Fill in repository details:
#* '''Name''': <code>wiki</code> (or <code>completenoobs-wiki</code>)
#* '''Description''': <code>CompleteNoobs Wiki - MediaWiki with pre-imported content from CompleteNoobs.com</code>
#* '''Visibility''': Select '''Public''' (free) or '''Private''' (requires subscription)
# Click '''Create'''

You now have a repository at: <code>docker.io/yourdockerid/wiki</code>

== Step 3: Login to Docker Hub from Terminal ==

=== 3.1: Open Terminal ===
<syntaxhighlight lang="bash">
# Open terminal on Ubuntu 24.04
# You can use Ctrl+Alt+T or search for "Terminal"
</syntaxhighlight>

=== 3.2: Login to Docker Hub ===
<syntaxhighlight lang="bash">
docker login
</syntaxhighlight>

You will see:<br>
<syntaxhighlight lang="bash">
USING WEB-BASED LOGIN

i Info → To sign in with credentials on the command line, use 'docker login -u <username>'

Your one-time device confirmation code is: MPMR-BKUH
Press ENTER to open your browser or submit your device code here: https://login.docker.com/activate

Waiting for authentication in the browser…

</syntaxhighlight>

go to https://login.docker.com/activate and enter the <b>confirmation code</b>, after which you will be asked to sign into docker, after that your set.

the terminal will change to include:
<pre>
WARNING! Your credentials are stored unencrypted in '/home/noob/.docker/config.json'.
Configure a credential helper to remove this warning. See
https://docs.docker.com/go/credential-store/

Login Succeeded
</pre>

== Step 4: Prepare Your Image ==

=== 4.1: Check Your Local Images ===
<syntaxhighlight lang="bash">
docker images
</syntaxhighlight>

You should see:
<syntaxhighlight lang="text">
REPOSITORY TAG IMAGE ID CREATED SIZE
completenoobs/wiki latest abc123def456 2 hours ago 1.5GB
</syntaxhighlight>

=== 4.2: Tag Your Image for Docker Hub ===
Replace <code>wiki</code> with your repo name
Replace <code>yourdockerid</code> with your actual Docker ID:
* Syntax:<code>docker tag YOURDOCKERID/YOUR_REPO_NAME:VERSION</code>

<syntaxhighlight lang="bash">
# Tag your image with your Docker Hub username
docker tag completenoobs/wiki:latest yourdockerid/wiki:latest

# Also create a version tag for better practice
docker tag completenoobs/wiki:latest yourdockerid/wiki:1.0

# Verify the tags
docker images

docker images | grep wiki
</syntaxhighlight>

You should now see multiple tags for the same image ID.

== Step 5: Push Image to Docker Hub ==

=== 5.1: Push the Image ===
<syntaxhighlight lang="bash">
# Push the latest tag
docker push yourdockerid/wiki:latest

# Push the version tag
docker push yourdockerid/wiki:1.0
</syntaxhighlight>

You'll see upload progress:
<syntaxhighlight lang="text">
The push refers to repository [docker.io/yourdockerid/wiki]
a1b2c3d4e5f6: Pushing [==============> ] 45.3MB/150MB
7g8h9i0j1k2l: Pushed
3m4n5o6p7q8r: Pushing [========> ] 25.6MB/100MB
...
latest: digest: sha256:abc123... size: 3245
</syntaxhighlight>

'''Note''': First push takes longer (uploads all layers). Subsequent pushes only upload changes.

== Step 6: Verify Upload ==

=== 6.1: Check on Docker Hub ===
# Go to: https://hub.docker.com/r/yourdockerid/wiki
# You should see:
#* Your repository
#* Tags (latest, 1.0)
#* Last pushed timestamp
#* Image size
#* Pull count (starts at 0)

=== 6.2: Update Repository Description ===
# Click on your repository
# Click '''Manage Repository''' (gear icon)
# Add a detailed description
# Add README content (supports Markdown):

<syntaxhighlight lang="markdown">
CompleteNoobs Wiki Docker Image

Pre-configured MediaWiki with CompleteNoobs.com content - For Local Use.
May require an update after first install - as for some reason some pages missing from first xml import
```bash
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
```

## Quick Start
```bash
docker run -d -p 8080:80 yourdockerid/wiki:latest
```
##Quick Start with Persistent Storage
```bash
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki \
completenoobs/cnoobs-wiki:latest
```
## Features
- MediaWiki 1.44
- Pre-imported CompleteNoobs content
- YouTube extension
- PageNotice extension
- SyntaxHighlight support
- XML update system

## Default Credentials
- Username: admin
- Password: AdminPass123!

## Volumes
- `/var/lib/mysql` - Database storage
- `/var/www/html/images` - Uploaded images

## More Information
Visit: https://completenoobs.com
</syntaxhighlight>

== Step 7: Test Download (Verify It Works) ==

=== 7.1: Remove Local Images (Optional) ===
To truly test downloading from Docker Hub:

<syntaxhighlight lang="bash">
# Stop and remove container if running
docker stop completenoobs_wiki
docker rm completenoobs_wiki

# Remove local images
docker rmi yourdockerid/wiki:latest
docker rmi yourdockerid/wiki:1.0
docker rmi completenoobs/wiki:latest
</syntaxhighlight>

=== 7.2: Pull From Docker Hub ===
<syntaxhighlight lang="bash">
# Pull your image from Docker Hub
docker pull yourdockerid/wiki:latest

# Run it
docker run -d -p 8080:80 --name test_wiki yourdockerid/wiki:latest

# Check it's working
docker logs test_wiki
curl http://localhost:8080
</syntaxhighlight>

== Step 8: Share With Others ==

=== 8.1: Basic Run Command ===
Share this simple command for others to use your image:

<syntaxhighlight lang="bash">
docker run -d -p 8080:80 yourdockerid/wiki:latest
</syntaxhighlight>

=== 8.2: Docker Compose File ===
Create a <code>docker-compose.yml</code> for easier deployment:

* With version 0.1 its all in one container so these commands do not really apply - just placeholder do now - will fix for 0.2
<syntaxhighlight lang="yaml">
version: '3.8'

services:
wiki:
image: yourdockerid/wiki:latest
container_name: completenoobs_wiki
ports:
- "8080:80"
volumes:
- mysql_data:/var/lib/mysql
- wiki_images:/var/www/html/images
restart: unless-stopped
environment:
- TZ=America/New_York # Adjust timezone

volumes:
mysql_data:
wiki_images:
</syntaxhighlight>

== Step 9: Best Practices ==

=== 9.1: Versioning ===
Always use version tags alongside 'latest':

<syntaxhighlight lang="bash">
# Bad (only latest)
docker push yourdockerid/wiki:latest

# Good (version + latest)
docker push yourdockerid/wiki:1.0
docker push yourdockerid/wiki:latest

# When updating
docker tag yourdockerid/wiki:latest yourdockerid/wiki:1.1
docker push yourdockerid/wiki:1.1
docker push yourdockerid/wiki:latest
</syntaxhighlight>

=== 9.2: Image Size Optimization ===
Before pushing, consider reducing image size:

<syntaxhighlight lang="bash">
# Check image size
docker images yourdockerid/wiki

# Remove unnecessary files in Dockerfile
# Use multi-stage builds if possible
# Clean package manager cache
</syntaxhighlight>

=== 9.3: Security ===
* Never include passwords in image (use environment variables)
* Regularly update base images
* Scan for vulnerabilities:

<syntaxhighlight lang="bash">
# Docker Scout (built-in to Docker Desktop)
docker scout cves yourdockerid/wiki:latest

# Or use Trivy
docker run --rm -v /var/run/docker.sock:/var/run/docker.sock \
aquasec/trivy image yourdockerid/wiki:latest
</syntaxhighlight>

== Step 10: Maintain Your Image ==

=== 10.1: Update Your Image ===
When you need to update:

<syntaxhighlight lang="bash">
# 1. Make changes to Dockerfile or scripts
cd ~/completenoobs-docker-image

# 2. Rebuild with new version
docker build -t yourdockerid/wiki:1.1 .

# 3. Test locally
docker run -d -p 8080:80 --name test yourdockerid/wiki:1.1
# ... test everything works ...
docker stop test && docker rm test

# 4. Tag as latest
docker tag yourdockerid/wiki:1.1 yourdockerid/wiki:latest

# 5. Push both tags
docker push yourdockerid/wiki:1.1
docker push yourdockerid/wiki:latest

# 6. Update Docker Hub description with changelog
</syntaxhighlight>

=== 10.2: Monitor Usage ===
Check Docker Hub regularly for:
* Pull count (how many times downloaded)
* User issues (check if you've linked a GitHub repo)
* Security scanning results

= Backup Docker Image Locally =

To back up a Docker image locally as a .tar file, which can then be stored on an external drive or transferred to another server, follow these steps.

== Steps ==

=== Save the Docker Image to a .tar File ===
Use the <code>docker save</code> command to export the image to a tarball:

<pre>
docker save -o /path/to/backup/my-image.tar my-image:latest
</pre>

* <code>-o</code>: Specifies the output file path (e.g., <code>/path/to/backup/my-image.tar</code>).
* <code>my-image:latest</code>: The name and tag of the image to back up.

Example:
<pre>
docker save -o /home/user/backups/my-image.tar my-image:latest
</pre>

=== Verify the Tarball ===
Ensure the .tar file was created:
<pre>
ls -lh /path/to/backup/my-image.tar
</pre>

=== Store on an External Drive ===
To store the image on an external drive (e.g., mounted at <code>/mnt/external</code>):

# Copy the .tar file to the external drive:
<pre>
cp /path/to/backup/my-image.tar /mnt/external/
</pre>

# Verify the file on the external drive:
<pre>
ls /mnt/external/
</pre>

# Safely unmount the external drive after copying:
<pre>
sudo umount /mnt/external
</pre>

= Send Docker Image to Another Server =

To transfer the saved Docker image to another server, use tools like <code>scp</code>, <code>rsync</code>, or <code>sftp</code> to securely copy the .tar file.

== Steps ==

=== Save the Docker Image ===
Follow the same <code>docker save</code> step as above to create the .tar file:
<pre>
docker save -o /path/to/backup/my-image.tar my-image:latest
</pre>

=== Transfer the Image to Another Server ===
Use <code>scp</code> to copy the .tar file to the remote server:
<pre>
scp /path/to/backup/my-image.tar user@remote-server:/path/to/destination/
</pre>

* Replace <code>user</code> with the remote server's username.
* Replace <code>remote-server</code> with the server's IP address or hostname.
* Replace <code>/path/to/destination/</code> with the destination path on the remote server.

Example:
<pre>
scp /home/user/backups/my-image.tar admin@192.168.1.100:/home/admin/backups/
</pre>

=== Load the Image on the Remote Server ===
On the remote server, use <code>docker load</code> to import the .tar file into Docker:
<pre>
docker load -i /path/to/destination/my-image.tar
</pre>

Example:
<pre>
docker load -i /home/admin/backups/my-image.tar
</pre>

Verify the image is loaded:
<pre>
docker images
</pre>

= Additional Tips =

== Compress the Image (Optional) ==
To save space, compress the .tar file before storing or transferring:
<pre>
gzip /path/to/backup/my-image.tar
</pre>

This creates <code>my-image.tar.gz</code>. To decompress on the destination:
<pre>
gunzip /path/to/backup/my-image.tar.gz
</pre>

== Use rsync for Large Files ==
For large .tar files, <code>rsync</code> can be more reliable than <code>scp</code>:
<pre>
rsync -avz /path/to/backup/my-image.tar user@remote-server:/path/to/destination/
</pre>

== Automate Backups ==
Create a script (e.g., <code>backup_docker.sh</code>) to automate backups:
<pre>
#!/bin/bash
IMAGE_NAME="my-image:latest"
BACKUP_PATH="/home/user/backups"
TIMESTAMP=$(date +%F_%H-%M-%S)
docker save -o "$BACKUP_PATH/my-image-$TIMESTAMP.tar" $IMAGE_NAME
</pre>

Make it executable:
<pre>
chmod +x backup_docker.sh
</pre>

Schedule it with cron:
<pre>
crontab -e
</pre>

Add a line to run daily at midnight:
<pre>
0 0 * * * /path/to/backup_docker.sh
</pre>

== Check Disk Space ==
Before saving or copying, ensure there's enough disk space:
<pre>
df -h /path/to/backup
df -h /mnt/external
</pre>

= Restoring the Image Locally =

To restore the image from an external drive or a local .tar file:
<pre>
docker load -i /path/to/backup/my-image.tar
</pre>

Verify:
<pre>
docker images
</pre>

== Common Issues and Solutions ==

=== Issue: "denied: requested access to the resource is denied" ===
'''Solution''': You're not logged in or using wrong username
<syntaxhighlight lang="bash">
docker logout
docker login
# Make sure to use YOUR Docker ID in the tag
docker tag completenoobs/wiki:latest YOURDOCKERID/wiki:latest
</syntaxhighlight>

=== Issue: "name unknown: repository name must be lowercase" ===
'''Solution''': Docker Hub requires lowercase names
<syntaxhighlight lang="bash">
# Wrong
docker tag image:latest YourName/Wiki:latest

# Correct
docker tag image:latest yourname/wiki:latest
</syntaxhighlight>

=== Issue: Push takes forever ===
'''Solution''': Large images take time on first push
* Be patient (can take 30+ minutes for large images)
* Ensure stable internet connection
* Consider optimizing image size
* Use <code>.dockerignore</code> file to exclude unnecessary files

=== Issue: "filesystem layer verification failed" ===
'''Solution''': Corrupted layer, rebuild and repush
<syntaxhighlight lang="bash">
docker build --no-cache -t yourdockerid/wiki:latest .
docker push yourdockerid/wiki:latest
</syntaxhighlight>

=== Issue: Error response from daemon: Get "https://registry-1.docker.io/v2/completenoobs/cnoobs-wiki/manifests/sha256:d6cc": net/http: TLS handshake timeout===

If then pulling a container <code>docker pull completenoobs/cnoobs-wiki:0.1</code> you see this error:
<pre>
Error response from daemon: Get "https://registry-1.docker.io/v2/completenoobs/cnoobs-wiki/manifests/sha256:d6cc65ee8f9716986c6b406a9c037b18ab3cf39326b21b42c6ad0d84c80693f4": net/http: TLS handshake timeout
</pre>

* Then restart docker

<pre>
sudo systemctl restart docker
</pre>

== Example Commands Summary ==

For quick reference, here are all the essential commands:

<syntaxhighlight lang="bash">
# Login to Docker Hub
docker login

# Tag your image
docker tag completenoobs/wiki:latest yourdockerid/wiki:latest
docker tag completenoobs/wiki:latest yourdockerid/wiki:1.0

# Push to Docker Hub
docker push yourdockerid/wiki:latest
docker push yourdockerid/wiki:1.0

# Others can now pull and run
docker pull yourdockerid/wiki:latest
docker run -d -p 8080:80 yourdockerid/wiki:latest

# Logout when done
docker logout
</syntaxhighlight>

CompleteNoobs Docker Image Creation

2025-09-01T17:39:54Z

AwesomO: /* Complete Noobs Docker Wiki Tutorial */

= Complete Noobs Docker Wiki Tutorial =
* [[Docker_Install_Guide| Docker install guide]]
==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 1: Clean Start ==
Remove any previous attempts:

<syntaxhighlight lang="bash">
# Stop and remove existing containers/images
docker stop completenoobs_wiki 2>/dev/null || true
docker rm completenoobs_wiki 2>/dev/null || true
docker rmi completenoobs/wiki:latest 2>/dev/null || true

# Remove old build directory
cd ~
rm -rf completenoobs-docker-image

# Create fresh directory
mkdir completenoobs-docker-image
cd completenoobs-docker-image
</syntaxhighlight>

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <nowiki><code><syntaxhighlight lang="python">code here</syntaxhighlight></code></nowiki>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

== Update System Features ==

=== How Updates Work ===
# Version Tracking: System tracks which XML dump version you have
# Smart Import: Only imports pages that don't exist locally
# Edit Preservation: Never overwrites pages you've edited
# Automatic Backup: Creates SQL backup before any updates
# User Confirmation: Asks before making changes
# Progress Feedback: Shows what's being imported/skipped

== Important Notes ==
* First Import: Initial build imports ALL content from XML
* Subsequent Updates: Only import NEW pages, preserving your edits
* Conflict Resolution: To force-update a specific page with XML version, delete it first through wiki interface
* Backups: Stored in /tmp/ (cleared on container restart)

CompleteNoobs Docker Image Creation

2025-09-01T17:36:41Z

AwesomO: Created page with "= Complete Noobs Docker Wiki Tutorial = ==errors== * This mainly works - just need to fix the extensions popular pages and contrubtion scores * The XML updater requires more work - currently idea placeholder == Prerequisites == * Ubuntu 24.04 * Docker installed and running * Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login) == Step 1: Clean Start == Remove any previous attempts: <syntaxhighlight lang="bash"> # Stop and remove e..."

= Complete Noobs Docker Wiki Tutorial =

==errors==
* This mainly works - just need to fix the extensions popular pages and contrubtion scores
* The XML updater requires more work - currently idea placeholder

== Prerequisites ==
* Ubuntu 24.04
* Docker installed and running
* Your user in docker group: <code>sudo usermod -aG docker $USER</code> (then logout/login)

== Step 1: Clean Start ==
Remove any previous attempts:

<syntaxhighlight lang="bash">
# Stop and remove existing containers/images
docker stop completenoobs_wiki 2>/dev/null || true
docker rm completenoobs_wiki 2>/dev/null || true
docker rmi completenoobs/wiki:latest 2>/dev/null || true

# Remove old build directory
cd ~
rm -rf completenoobs-docker-image

# Create fresh directory
mkdir completenoobs-docker-image
cd completenoobs-docker-image
</syntaxhighlight>

== Step 2: Create All Files ==

=== 2.1: Dockerfile ===
<syntaxhighlight lang="bash">
nano Dockerfile
</syntaxhighlight>
Copy this exactly:

<syntaxhighlight lang="dockerfile">
FROM mediawiki:1.44
# Mediawiki 1.44 used over latest because can confirm extensions youtube and pagenotice works
# Install dependencies
RUN apt-get update && apt-get install -y \
mariadb-server \
python3 \
python3-requests \
python3-bs4 \
python3-pygments \
curl \
wget \
unzip \
nano \
git \
&& apt-get clean

# Copy scripts
COPY download_latest_xml.py /usr/src/download_latest_xml.py
COPY setup_wiki.sh /usr/src/setup_wiki.sh
COPY update_xml.sh /usr/src/update_xml.sh
COPY entrypoint.sh /entrypoint.sh

# Make executable
RUN chmod +x /usr/src/setup_wiki.sh /entrypoint.sh /usr/src/update_xml.sh

# Download XML
RUN python3 /usr/src/download_latest_xml.py

# Setup wiki
RUN /usr/src/setup_wiki.sh

EXPOSE 80
VOLUME /var/lib/mysql
VOLUME /var/www/html/images

ENTRYPOINT ["/entrypoint.sh"]
</syntaxhighlight>

=== 2.2: XML Download Script ===
<syntaxhighlight lang="bash">
nano download_latest_xml.py
</syntaxhighlight>

<syntaxhighlight lang="python">
#!/usr/bin/env python3
import os
import requests
from bs4 import BeautifulSoup
import re

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_available_dumps():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
return sorted(dumps, key=parse_date_from_dump, reverse=True)
except Exception as e:
print(f"Error fetching dumps: {e}")
return []

def get_dump_files(dump):
try:
response = requests.get(f"{BASE_URL}{dump}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]
return sorted(files, reverse=True)
except Exception as e:
print(f"Error fetching dump files: {e}")
return []

def download_file(url, filename):
try:
print(f"Downloading {filename}...")
response = requests.get(url, stream=True, timeout=60)
response.raise_for_status()

total_size = int(response.headers.get('content-length', 0))
downloaded = 0

with open(filename, 'wb') as f:
for chunk in response.iter_content(chunk_size=8192):
if chunk:
f.write(chunk)
downloaded += len(chunk)
if total_size > 0:
progress = (downloaded / total_size) * 100
print(f"\rProgress: {progress:.1f}%", end='', flush=True)
print()
return True
except Exception as e:
print(f"Error downloading {filename}: {e}")
return False

def main():
print("Fetching available XML dumps...")
dumps = get_available_dumps()

if not dumps:
print("No dumps found!")
exit(1)

newest_dump = dumps[0]
print(f"Latest dump: {newest_dump}")

files = get_dump_files(newest_dump)
if not files:
print("No XML files found in latest dump!")
exit(1)

newest_xml = files[0]
xml_url = f"{BASE_URL}{newest_dump}/{newest_xml}"
local_filename = "/tmp/completenoobs_dump.xml"

if download_file(xml_url, local_filename):
print(f"Successfully downloaded {newest_xml}")
with open("/tmp/dump_info.txt", "w") as f:
f.write(f"{newest_dump}/{newest_xml}")
else:
print("Failed to download XML dump!")
exit(1)

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

=== 2.3: Main Setup Script ===
<syntaxhighlight lang="bash">
nano setup_wiki.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "Setting up CompleteNoobs Wiki..."

# Initialize MariaDB
if [ ! -d "/var/lib/mysql/mysql" ]; then
mysql_install_db --user=mysql --datadir=/var/lib/mysql
fi

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 2
done

# Setup database
mysql -e "CREATE DATABASE IF NOT EXISTS completenoobs_wiki CHARACTER SET utf8mb4 COLLATE utf8mb4_unicode_ci;"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'127.0.0.1' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'127.0.0.1';"
mysql -e "CREATE USER IF NOT EXISTS 'wikiuser'@'localhost' IDENTIFIED BY 'wikipass';"
mysql -e "GRANT ALL PRIVILEGES ON completenoobs_wiki.* TO 'wikiuser'@'localhost';"
mysql -e "FLUSH PRIVILEGES;"

# Install MediaWiki
cd /var/www/html
php maintenance/install.php \
--dbtype=mysql \
--dbserver=127.0.0.1 \
--dbname=completenoobs_wiki \
--dbuser=wikiuser \
--dbpass=wikipass \
--server="http://localhost:8080" \
--scriptpath="" \
--lang=en \
--pass=AdminPass123! \
"CompleteNoobs Wiki" \
"admin"

# Download and install extensions
cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageNotice --branch REL1_44 || echo "PageNotice download failed, continuing..."
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/YouTube --branch REL1_44 || echo "YouTube download failed, continuing..."
cd /var/www/html

# Configure LocalSettings.php
cat >> LocalSettings.php << 'EOF'
# Basic settings
$wgEnableUploads = true;
$wgUseImageMagick = true;
$wgImageMagickConvertCommand = "/usr/bin/convert";
$wgDefaultSkin = "vector-2022";
$wgAllowExternalImages = true;

# Debug (can be removed later)
$wgShowExceptionDetails = true;
$wgDebugLogFile = "/tmp/mediawiki-debug.log";

# PageNotice extension (if available)
if ( file_exists( "$IP/extensions/PageNotice/extension.json" ) ) {
wfLoadExtension( 'PageNotice' );
}

# YouTube extension (if available)
if ( file_exists( "$IP/extensions/YouTube/extension.json" ) ) {
wfLoadExtension( 'YouTube' );
}

# SyntaxHighlight (usually bundled)
if ( file_exists( "$IP/extensions/SyntaxHighlight_GeSHi/extension.json" ) ) {
wfLoadExtension( 'SyntaxHighlight_GeSHi' );
$wgPygmentizePath = '/usr/bin/pygmentize';
}
EOF

# Import XML dump if available
if [ -f "/tmp/completenoobs_dump.xml" ]; then
echo "Importing XML dump..."

if php maintenance/importDump.php --uploads < /tmp/completenoobs_dump.xml; then
echo "XML import completed!"
else
echo "XML import had warnings"
fi

# Basic maintenance
php maintenance/update.php --quick || echo "Update completed with warnings"
php maintenance/rebuildrecentchanges.php || echo "RecentChanges rebuilt with warnings"
php maintenance/initSiteStats.php || echo "SiteStats initialized with warnings"

if [ -f "/tmp/dump_info.txt" ]; then
echo "Import: $(cat /tmp/dump_info.txt)" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import
fi
else
echo "No XML dump found - starting with empty wiki"
fi

# Copy update script to accessible location
cp /usr/src/update_xml.sh /var/www/html/update_xml.sh
chmod +x /var/www/html/update_xml.sh

# Create user-friendly update wrapper
cat > /var/www/html/check_updates.sh << 'UPDATE_WRAPPER_EOF'
#!/bin/bash
echo "=== CompleteNoobs Wiki Update Checker ==="
echo ""
echo "This tool checks for new content from the CompleteNoobs XML repository"
echo "and imports ONLY new pages, preserving all your local edits."
echo ""

/var/www/html/update_xml.sh
UPDATE_WRAPPER_EOF
chmod +x /var/www/html/check_updates.sh

# Create simple status script
cat > /var/www/html/check_status.sh << 'STATUS_EOF'
#!/bin/bash
cd /var/www/html
echo "=== Wiki Status ==="
echo "Pages: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "Error")"
echo "Users: $(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM user WHERE user_id > 0;" -s -N 2>/dev/null || echo "Error")"
echo ""
echo "=== Extensions ==="
if [ -d "extensions/PageNotice" ]; then
echo "PageNotice: Installed"
else
echo "PageNotice: Not installed"
fi
if [ -d "extensions/YouTube" ]; then
echo "YouTube: Installed"
else
echo "YouTube: Not installed"
fi
if [ -d "extensions/ContributionScores" ]; then
echo "ContributionScores: Installed"
else
echo "ContributionScores: Not installed"
fi
echo ""
echo "=== Update System ==="
if [ -f ".last_import" ]; then
echo "Current version: $(grep 'Import:' .last_import | cut -d' ' -f2)"
echo "Import date: $(grep 'Date:' .last_import | cut -d' ' -f2-)"
else
echo "No version info available"
fi
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
STATUS_EOF
chmod +x /var/www/html/check_status.sh

echo ""
echo "Setup completed!"
echo "Admin: admin / AdminPass123!"
echo "Update scripts installed:"
echo "- /var/www/html/check_updates.sh (user-friendly)"
echo "- /var/www/html/update_xml.sh (direct)"

# Final counts
PAGES=$(mysql --user=wikiuser --password=wikipass completenoobs_wiki -e "SELECT COUNT(*) FROM page;" -s -N 2>/dev/null || echo "0")
echo "Pages imported: $PAGES"

service mariadb stop
</syntaxhighlight>

=== 2.4: XML Update Script ===
<syntaxhighlight lang="bash">
nano update_xml.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash
set -e

echo "=== CompleteNoobs Wiki XML Updater ==="
echo "This will check for new and updated pages"
echo ""

# Function to check if running in container
check_environment() {
if [ ! -f "/var/www/html/LocalSettings.php" ]; then
echo "Error: This script must be run inside the wiki container"
exit 1
fi
}

# Function to get current XML version
get_current_version() {
if [ -f "/var/www/html/.last_import" ]; then
grep "Import:" /var/www/html/.last_import | cut -d' ' -f2
else
echo "none"
fi
}

# Function to check for updates
check_for_updates() {
python3 - << 'PYTHON_EOF'
import requests
from bs4 import BeautifulSoup
import re
import sys

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

def parse_date_from_dump(dump_name):
match = re.match(r'(\d{2})_(\d{2})_(\d{2})\.Noobs', dump_name)
if match:
day, month, year = match.groups()
year_int = int(year)
full_year = 2000 + year_int if year_int <= 49 else 1900 + year_int
return (full_year, int(month), int(day))
return (0, 0, 0)

def get_latest_dump():
try:
response = requests.get(BASE_URL, timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
dumps = [link.get('href').rstrip('/') for link in soup.find_all('a')
if re.match(r'\d{2}_\d{2}_\d{2}\.Noobs/$', link.get('href', ''))]
if dumps:
latest = sorted(dumps, key=parse_date_from_dump, reverse=True)[0]

# Get XML files from latest dump
response = requests.get(f"{BASE_URL}{latest}/", timeout=30)
response.raise_for_status()
soup = BeautifulSoup(response.text, 'html.parser')
files = [link.get('href') for link in soup.find_all('a')
if link.get('href', '').endswith('.xml')]

if files:
newest_xml = sorted(files, reverse=True)[0]
print(f"{latest}/{newest_xml}")
sys.exit(0)
except Exception as e:
print(f"ERROR: {e}", file=sys.stderr)
sys.exit(1)

print("ERROR: No dumps found", file=sys.stderr)
sys.exit(1)

get_latest_dump()
PYTHON_EOF
}

# Function to download new XML
download_xml() {
local dump_info="$1"
local dump_dir=$(echo "$dump_info" | cut -d'/' -f1)
local xml_file=$(echo "$dump_info" | cut -d'/' -f2)
local url="https://xml.completenoobs.com/xmlDumps/${dump_info}"

echo "Downloading: $xml_file"
echo "From: $dump_dir"
echo "URL: $url"

if wget -O /tmp/new_dump.xml "$url" --progress=bar:force 2>&1; then
echo "Download successful!"
return 0
else
echo "Download failed!"
return 1
fi
}

# Function to backup current database
backup_database() {
echo "Creating database backup..."
TIMESTAMP=$(date +%Y%m%d_%H%M%S)
mysqldump --user=wikiuser --password=wikipass completenoobs_wiki > /tmp/wiki_backup_${TIMESTAMP}.sql
echo "Backup created: /tmp/wiki_backup_${TIMESTAMP}.sql"
}

# Function to analyze and import changes
analyze_and_import() {
echo "Analyzing differences between XML and local wiki..."

# Create analysis and import script for MediaWiki 1.44+
cat > /tmp/analyze_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class AnalyzeAndImport extends Maintenance {
private $db;
private $new_pages = [];
private $changed_pages = [];
private $unchanged_pages = [];

public function __construct() {
parent::__construct();
$this->addDescription('Analyze and selectively import from XML dump');
}

public function execute() {
$this->db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// MediaWiki 1.35+ uses slots and content tables
// Get existing pages with their content
$query = "
SELECT p.page_title, p.page_id, c.content_address, c.content_sha1
FROM page p
JOIN revision r ON p.page_latest = r.rev_id
JOIN slots s ON r.rev_id = s.slot_revision_id
JOIN slot_roles sr ON s.slot_role_id = sr.role_id
JOIN content c ON s.slot_content_id = c.content_id
WHERE p.page_namespace = 0 AND sr.role_name = 'main'
";

$result = $this->db->query($query);
if (!$result) {
$this->error("Database query failed: " . $this->db->error);
return;
}

$existing = [];
while ($row = $result->fetch_assoc()) {
// Get actual text content
$text_content = $this->getTextContent($row['content_address']);
$existing[$row['page_title']] = [
'id' => $row['page_id'],
'content' => $text_content,
'sha1' => $row['content_sha1']
];
}

// Parse XML and compare
$xml = simplexml_load_file('/tmp/new_dump.xml');

foreach ($xml->page as $page) {
$title = str_replace(' ', '_', (string)$page->title);
$xml_content = (string)$page->revision->text;

if (!isset($existing[$title])) {
// New page
$this->new_pages[$title] = $xml_content;
} else {
// Compare content using SHA1 for efficiency
$xml_sha1 = sha1($xml_content);

if ($existing[$title]['sha1'] !== $xml_sha1) {
// Content is different
$this->changed_pages[$title] = [
'local' => $existing[$title]['content'],
'xml' => $xml_content,
'page_id' => $existing[$title]['id']
];
} else {
$this->unchanged_pages[] = $title;
}
}
}

// Display summary
$this->output("\n=== Update Analysis ===\n");
$this->output("New pages to import: " . count($this->new_pages) . "\n");
$this->output("Changed pages found: " . count($this->changed_pages) . "\n");
$this->output("Unchanged pages: " . count($this->unchanged_pages) . "\n");

// Save analysis for review
file_put_contents('/tmp/update_analysis.json', json_encode([
'new' => array_keys($this->new_pages),
'changed' => array_keys($this->changed_pages),
'unchanged' => $this->unchanged_pages
], JSON_PRETTY_PRINT));

// Show changed pages with preview (limit to first 20 for readability)
if (count($this->changed_pages) > 0) {
$this->output("\n=== Changed Pages ===\n");
$count = 0;
$total_changed = count($this->changed_pages);

foreach ($this->changed_pages as $title => $data) {
$count++;
if ($count <= 20) {
$this->output("\n$count. $title\n");

// Create a simple diff preview (first 300 chars)
$xml_preview = substr($data['xml'], 0, 100);

// Save full diff to file
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
file_put_contents($diff_file, "=== FULL DIFF FOR: $title ===\n\n");
file_put_contents($diff_file, "--- LOCAL VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['local'] . "\n\n", FILE_APPEND);
file_put_contents($diff_file, "--- XML VERSION ---\n", FILE_APPEND);
file_put_contents($diff_file, $data['xml'], FILE_APPEND);

$this->output(" Preview: " . $xml_preview . "...\n");
}
}

if ($total_changed > 20) {
$this->output("\n... and " . ($total_changed - 20) . " more changed pages.\n");
$this->output("All diff files saved to /tmp/diff_*.txt\n");
}
}

// Interactive selection
if (count($this->new_pages) > 0 || count($this->changed_pages) > 0) {
$this->output("\n=== Import Options ===\n");
$this->output("1. Import new pages only (preserve all local changes)\n");
$this->output("2. Import new pages + update ALL changed pages (overwrites local changes)\n");
$this->output("3. Selective import (choose which updates to apply)\n");
$this->output("4. Cancel (no changes)\n");

// Save state for import script WITHOUT the XML object
$import_data = [
'new_pages' => $this->new_pages,
'changed_pages' => $this->changed_pages,
'xml_file' => '/tmp/new_dump.xml' // Save path instead of object
];

file_put_contents('/tmp/import_data.ser', serialize($import_data));
} else {
$this->output("\nNo changes detected. Your wiki is up to date!\n");
}
}

private function getTextContent($address) {
// Handle different content storage formats in MW 1.35+
if (strpos($address, 'tt:') === 0) {
// Text table reference
$text_id = substr($address, 3);
$result = $this->db->query("SELECT old_text FROM text WHERE old_id = $text_id");
if ($row = $result->fetch_assoc()) {
return $row['old_text'];
}
} elseif (strpos($address, 'es:') === 0) {
// External storage - would need special handling
return "[External storage content]";
}
// Direct content
return $address;
}
}

$maintClass = AnalyzeAndImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/analyze_import.php
}

# Function to perform selected import
perform_import() {
local choice=$1

cat > /tmp/do_import.php << 'PHP_EOF'
<?php
require_once '/var/www/html/maintenance/Maintenance.php';

class DoImport extends Maintenance {
public function __construct() {
parent::__construct();
$this->addOption('mode', 'Import mode', true, true);
}

public function execute() {
$mode = $this->getOption('mode');
$data = unserialize(file_get_contents('/tmp/import_data.ser'));

// Load XML file
$xml = simplexml_load_file($data['xml_file']);

$new_imported = 0;
$updated = 0;

// Import new pages (always for modes 1-3)
if ($mode != '4') {
foreach ($data['new_pages'] as $title => $content) {
$this->importPage($title, $content, $xml);
$new_imported++;
$this->output("Imported new page: $title\n");
}
}

// Handle changed pages based on mode
if ($mode == '2') {
// Update all changed pages
foreach ($data['changed_pages'] as $title => $info) {
$this->output("Updating: $title\n");
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated page: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
}
} elseif ($mode == '3') {
// Selective update
$this->output("\n=== Selective Import Mode ===\n");
$this->output("For each changed page, choose:\n");
$this->output(" y = yes, update this page\n");
$this->output(" n = no, keep local version\n");
$this->output(" d = show diff file\n");
$this->output(" a = update all remaining pages\n");
$this->output(" s = skip all remaining pages\n\n");

$update_all = false;
$skip_all = false;

foreach ($data['changed_pages'] as $title => $info) {
if ($skip_all) {
$this->output("Skipped: $title\n");
continue;
}

if ($update_all) {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
continue;
}

$this->output("\nPage: $title\n");
$this->output("Action (y/n/d/a/s): ");
$handle = fopen("php://stdin", "r");
$line = trim(fgets($handle));

while ($line == 'd') {
// Show diff
$safe_title = preg_replace('/[^a-zA-Z0-9_-]/', '_', $title);
$diff_file = "/tmp/diff_${safe_title}.txt";
if (file_exists($diff_file)) {
system("head -50 $diff_file");
$this->output("\n[Showing first 50 lines - full file at $diff_file]\n");
}
$this->output("Action (y/n/a/s): ");
$line = trim(fgets($handle));
}

if ($line == 'a') {
$update_all = true;
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
}
} elseif ($line == 's') {
$skip_all = true;
$this->output("Skipped: $title\n");
} elseif ($line == 'y') {
if ($this->reimportPage($title, $xml)) {
$updated++;
$this->output("Updated: $title\n");
} else {
$this->output("Failed to update: $title\n");
}
} else {
$this->output("Skipped: $title\n");
}
}
}

$this->output("\n=== Import Complete ===\n");
$this->output("New pages imported: $new_imported\n");
$this->output("Pages updated: $updated\n");
}

private function importPage($title, $content, $xml) {
// Create single page XML for import
$tempFile = '/tmp/single_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

// Find and add the page
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}
break;
}
}

$singlePage->asXML($tempFile);
exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1");
unlink($tempFile);
}

private function reimportPage($title, $xml) {
// For updating existing pages, delete then reimport
$db = new mysqli('127.0.0.1', 'wikiuser', 'wikipass', 'completenoobs_wiki');

// Delete the existing page
$safe_title = $db->real_escape_string(str_replace(' ', '_', $title));
$db->query("DELETE FROM page WHERE page_title = '$safe_title' AND page_namespace = 0");

$db->close();

// Now import the new version
foreach ($xml->page as $page) {
if (str_replace(' ', '_', (string)$page->title) == $title) {
$tempFile = '/tmp/update_page_' . md5($title) . '.xml';
$singlePage = new SimpleXMLElement('<?xml version="1.0" encoding="utf-8"?><mediawiki></mediawiki>');

if ($xml->siteinfo) {
$siteinfo = $singlePage->addChild('siteinfo');
foreach ($xml->siteinfo->children() as $child) {
$siteinfo->addChild($child->getName(), (string)$child);
}
}

$newPage = $singlePage->addChild('page');
foreach ($page->children() as $child) {
if ($child->getName() == 'revision') {
$revision = $newPage->addChild('revision');
foreach ($child->children() as $revChild) {
$revision->addChild($revChild->getName(), (string)$revChild);
}
} else {
$newPage->addChild($child->getName(), (string)$child);
}
}

$singlePage->asXML($tempFile);
$result = exec("php /var/www/html/maintenance/importDump.php < $tempFile 2>&1", $output, $return);
unlink($tempFile);

return ($return === 0);
}
}

return false;
}
}

$maintClass = DoImport::class;
require_once RUN_MAINTENANCE_IF_MAIN;
PHP_EOF

cd /var/www/html
php /tmp/do_import.php --mode="$choice"
}

# Main execution
main() {
check_environment

# Start MariaDB if not running
service mariadb status > /dev/null 2>&1 || service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
break
fi
sleep 1
done

CURRENT=$(get_current_version)
echo "Current version: $CURRENT"
echo ""

echo "Checking for updates..."
LATEST=$(check_for_updates 2>/dev/null)
if [ $? -ne 0 ] || [ -z "$LATEST" ] || [[ "$LATEST" == *"ERROR"* ]]; then
echo "Failed to check for updates"
exit 1
fi

echo "Latest available: $LATEST"
echo ""

# Always proceed to analysis even if versions match
# (there might be content updates in the same version)
echo "Proceeding with content analysis..."
echo ""

# Backup database
backup_database

# Download new XML
if ! download_xml "$LATEST"; then
echo "Failed to download new XML"
exit 1
fi

# Analyze differences
analyze_and_import

# Check if there are changes to import
if [ -f "/tmp/import_data.ser" ]; then
echo ""
read -p "Choose option (1-4): " -n 1 -r
echo

if [[ $REPLY =~ ^[1-4]$ ]]; then
if [ "$REPLY" != "4" ]; then
perform_import "$REPLY"

# Update version info
echo "Import: $LATEST" > /var/www/html/.last_import
echo "Date: $(date)" >> /var/www/html/.last_import

# Rebuild indices
echo "Rebuilding indices..."
php maintenance/rebuildrecentchanges.php
php maintenance/initSiteStats.php
else
echo "Update cancelled"
fi
else
echo "Invalid option. Update cancelled"
fi
fi

# Clean up temp files
rm -f /tmp/import_data.ser /tmp/update_analysis.json /tmp/diff_*.txt /tmp/analyze_import.php /tmp/do_import.php 2>/dev/null

echo ""
echo "Done!"
}

# Run main function
main "$@"
</syntaxhighlight>

=== 2.5: Entrypoint Script ===
<syntaxhighlight lang="bash">
nano entrypoint.sh
</syntaxhighlight>

<syntaxhighlight lang="bash">
#!/bin/bash

echo "Starting CompleteNoobs Wiki..."

service mariadb start

# Wait for MariaDB
for i in {1..30}; do
if mysql -e "SELECT 1;" &>/dev/null; then
echo "MariaDB ready!"
break
fi
sleep 1
done

echo ""
echo "CompleteNoobs Wiki ready at: http://localhost:8080"
echo "Admin login: admin / AdminPass123!"
echo ""
echo "Features:"
echo "- Complete wiki content imported from XML"
echo "- License notices on all pages (via PageNotice)"
echo "- SyntaxHighlight for code blocks"
echo "- YouTube video embedding"
echo "- Contribution Scores special page"
echo "- XML update system (preserves local edits)"
echo ""
echo "To check for updates: docker exec -it completenoobs_wiki /var/www/html/check_updates.sh"
echo ""

apache2-foreground
</syntaxhighlight>

== Step 3: Build and Run ==

=== 3.1: Build the Image ===
<syntaxhighlight lang="bash">
docker build -t completenoobs/wiki:latest .
</syntaxhighlight>
This will take several minutes.

=== 3.2: Run the Container ===
<syntaxhighlight lang="bash">
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Step 4: Test Everything ==

=== 4.1: Check the Wiki ===
* Visit: http://localhost:8080
* You should see the PageNotice at the top
* Login with: admin / AdminPass123!

<div class="toccolours mw-collapsible mw-collapsed">
Change Admin Password:
<div class="mw-collapsible-content">

By default, the admin user's password is <code>AdminPass123!</code>. It's highly recommended to change this immediately. You can do this either through the wiki's web interface or directly in the Docker terminal.<br><br>

<b>Method 1: Change Password via Web Interface</b><br>
This is the easiest method. You can change your password directly from the wiki itself.<br>

1. Log in to your wiki with the default credentials: <code>admin</code> / <code>AdminPass123!</code>.<br>
2. Once logged in, click your username (<code>admin</code>) in the top-right corner of the page.<br>
3. From the drop-down menu, select <b>Preferences</b>.<br>
4. On the Preferences page, go to the <b>Password</b> tab.<br>
5. Enter the current password (<code>AdminPass123!</code>), then enter your new password twice.<br>
6. Click <b>Change password</b>.<br>

Your password is now changed, and you will need to use the new one for future logins.<br><br>

<b>Method 2: Change Password via Terminal (No-Email Reset)</b><br>
If you have forgotten the password or prefer to use the command line, you can reset it directly inside the Docker container using a MediaWiki maintenance script.<br>

1. <b>Access the container's shell</b> with the following command from your host machine:<br>
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

2. Once inside the container, use the <code>changePassword.php</code> maintenance script to change the password. This is the modern, recommended way to run MediaWiki maintenance scripts.<br>
* Change <b>NEWPASSWORD</b> to your new password<br>
<syntaxhighlight lang="bash">
php /var/www/html/maintenance/run.php changePassword.php --user=admin --password=NEWPASSWORD
</syntaxhighlight>

3. Type <code>exit</code> to leave the container's shell.<br>

The admin password has now been reset. You can log in to your wiki with the new password.
</div>
</div>

=== 4.2: Test Extensions ===
* '''YouTube''': Edit any page, add <code><youtube>N9qYF9DZPdw</youtube></code>
* '''PageNotice''': Should already be visible at the top
* '''SyntaxHighlight''': Add code blocks with <code><syntaxhighlight lang="python">code here</syntaxhighlight></code>

=== 4.3: Check Status ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki /var/www/html/check_status.sh
</syntaxhighlight>

== Step 5: XML Update Operations ==
*NOTE: update_xml.sh still needs alot of work, this just idea placeholder for now.
=== 5.1: Check for Updates (Interactive) ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki /var/www/html/check_updates.sh
</syntaxhighlight>
This will:
* Check the CompleteNoobs XML repository for new dumps
* Compare with your current version
* Ask for confirmation before updating
* Import ONLY new pages (preserves your edits)
* Create a backup before making changes

=== 5.2: Force Update (Non-Interactive) ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki bash -c "echo 'y' | /var/www/html/update_xml.sh"
</syntaxhighlight>

=== 5.3: Manual Update Process ===
<syntaxhighlight lang="bash">
# 1. Enter container
docker exec -it completenoobs_wiki bash

# 2. Check current version
cat /var/www/html/.last_import

# 3. Run update
/var/www/html/check_updates.sh

# 4. Exit container
exit
</syntaxhighlight>

== Step 6: Troubleshooting Commands ==
=== Access container shell: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki bash
</syntaxhighlight>

=== Edit configuration: ===
<syntaxhighlight lang="bash">
docker exec -it completenoobs_wiki nano /var/www/html/LocalSettings.php
</syntaxhighlight>

=== Check logs: ===
<syntaxhighlight lang="bash">
docker logs completenoobs_wiki
</syntaxhighlight>

=== View update logs: ===
<syntaxhighlight lang="bash">
docker exec completenoobs_wiki tail -f /tmp/mediawiki-debug.log
</syntaxhighlight>

=== Complete restart: ===
<syntaxhighlight lang="bash">
docker stop completenoobs_wiki
docker rm completenoobs_wiki
docker run -d -p 8080:80 \
-v completenoobs_mysql:/var/lib/mysql \
-v completenoobs_images:/var/www/html/images \
--name completenoobs_wiki completenoobs/wiki:latest
</syntaxhighlight>

== Expected Results ==
* Working wiki with imported CompleteNoobs content
* PageNotice visible at top of all pages
* All extensions functional
* Text editors (nano/vim) available in container
* Utility scripts for maintenance
* XML update system that preserves local edits

== Update System Features ==

=== How Updates Work ===
# Version Tracking: System tracks which XML dump version you have
# Smart Import: Only imports pages that don't exist locally
# Edit Preservation: Never overwrites pages you've edited
# Automatic Backup: Creates SQL backup before any updates
# User Confirmation: Asks before making changes
# Progress Feedback: Shows what's being imported/skipped

== Important Notes ==
* First Import: Initial build imports ALL content from XML
* Subsequent Updates: Only import NEW pages, preserving your edits
* Conflict Resolution: To force-update a specific page with XML version, delete it first through wiki interface
* Backups: Stored in /tmp/ (cleared on container restart)

Ubuntu2404 Install Docker and Docker Compose

2025-09-01T17:34:45Z

AwesomO:

Ubuntu2404 Install Docker and Docker Compose

2025-08-30T14:40:45Z

AwesomO: /* Install Docker and Docker Compose */