See all pages at once.
The wiki is divided into 4 main areas:
In each section, the respective tutorials and explanations are listed.
To create or change wiki pages, you first need an account at PwOSS - Gitea. See the Wiki page - Gitea for more explanations about Gitea, including instructions on how to Fork
the wiki and create a Pull Request
. Which is important to create or change wiki pages!
root | Description |
---|---|
content | inlcudes all "organizations" |
deprecated | to keep unused pages |
public | includes all assets (images, css, fonts,...) |
LICENSE | Wiki license |
README.md | Gitea/git README file |
all-pages.md | listed ALL pages of the wiki |
custom.css | design of the wiki |
Home.md | the main wiki page |
Organizations | Description |
---|---|
desktop | includes the Arch installation |
mobile | includes Android, Linux content and an apple.md file |
pwoss | includes all about pwoss |
server | includes all the tutorials about the x86_64 server |
The desktop is really simple.
Just an arch.md
file, desktop-software-suite.md
and the _Footer.md
.
Mobile is in general a tough fight. Not only the flashing process, also the how to.
At first we have an android.md
which covers all content from the android folder. We have also added an apple.md
file if someone is able to create some privacy ideas about Apple. Since February 2020 we also include Linux installations.
The Android folder covers the entire installation process and contains some information about Android in general.
The devices folders are tutorials for specific phones.
Contains everything about PwOSS like this Wiki how to.
Contains every tutorial and the list of the _Footer.md
, arch-x86_64.md
, arch-server-docu.md
and server-software-suite.md
.
Unused pages can be moved to this folder.
Usually only the image folder is important. Why is described below.
Before you start changing any pages, you need to know how the wiki works.
All pages are mainly located in the content
folder. As described above. If necessary, create a new folder.
This covers the basics and some PwOSS rules.
The full description are avilable at github.com/gollum.
Every folder contains a _Footer.md
file, but ...
... do NOT add a _Footer.md
, _Header.md
or _Sidebar.md
file to the root folder! It overwrites all other _Footer.md
, _Header.md
or _Sidebar.md
created in other folders. It is a global _Footer.md
, _Header.md
or _Sidebar.md
option. Which isn't really helpful.
Any Pull Requests
of these files will be rejected. Security concerns.
If you want to link to another wiki page, please use [another wiki page](/content/organization/page-file-name.md)
.
Fork
the wiki and want to use it on your computer or if others want to use it on their computers. Otherwise, they will be redirected to https://wiki.pwoss.org.Tags:
[description](/path/to/page-file-name.md)
Please add all images under /public/images/
and create a new folder if necessary.
Tags:

[[/public/images/path/to/your/image.png]]
[[/public/images/path/to/your/image.png|alt=text]]
[[/public/images/path/to/your/image.png|frame]]
<span class="frame">
, which will display a border around the image.[[/public/images/path/to/your/image.png|align=position]]
left
, center
, and right
. Default: left
.[[/public/images/path/to/your/image.png|float]]
align=center
option. When floating is enabled and alignment is not specified, align=left
is applied.[[/public/images/path/to/your/image.png|height=value]]
px
or em
unit.[[/public/images/path/to/your/image.png|width=value]]
px
or em
unit.
This makes it easier for you if you want to change some pages or create new ones. You can check the changes before starting a pull request. You can also use it for your own needs.
sudo pacman -S ruby ruby-rdoc cmake git
mkdir -p ~/your/wiki/path
git init ~/your/wiki/path
gem install gollum
gem install github-markdown
gem update
Copy config.rb
, public
and the templates
into your wiki.
cp ~/.gem/ruby/2.7.0/gems/gollum-5.*/config.rb ~/your/wiki/path/config.rb
cp -r ~/.gem/ruby/2.7.0/gems/gollum-5.*/lib/gollum/public/gollum ~/your/wiki/path/public
cp -r ~/.gem/ruby/2.7.0/gems/gollum-5.*/lib/gollum/templates ~/your/wiki/path/public/templates
Create a service to run it on every boot.
sudo nano /lib/systemd/system/gollum.service
[Unit]
Description=Gollum wiki server
After=network.target
[Service]
Type=simple
User=USER
Group=USER
WorkingDirectory=/home/USER/your/wiki/path
ExecStart=/bin/bash -c "PATH=/home/USER/.gem/ruby/2.7.0/bin:$PATH exec gollum --config /home/USER/your/wiki/path/config.rb --template-dir /home/USER/your/wiki/path/public/templates/ --css"
Restart=on-abort
[Install]
WantedBy=multi-user.target
sudo systemctl enable gollum.service && sudo systemctl start gollum.service
Create a file, add images, etc. and add your description.
After you have added your content, you need to run the following commands in your Wiki root directory:
git add .
git commit -m "your explanation about the content, changes ..."
cd /home/user/pwoss/path/to/the/
git clone https://git.pwoss.org/PwOSS/Wiki.git
sudo nano /lib/systemd/system/gollum.service
[Unit]
Description=Gollum wiki server
After=network.target
[Service]
Type=simple
User=USER
Group=USER
# your-wiki
#WorkingDirectory=/home/USER/your/wiki/path
#ExecStart=/bin/bash -c "PATH=/home/USER/.gem/ruby/2.7.0/bin:$PATH exec gollum --config /home/USER/your/wiki/path/config.rb --template-dir /home/USER/your/wiki/path/public/templates/ --css"
# PwOSS - Wiki
WorkingDirectory=/home/USER/pwoss/path/to/the/Wiki
ExecStart=/bin/bash -c "PATH=/home/USER/.gem/ruby/2.7.0/bin:$PATH exec gollum --config /home/USER/your/wiki/path/config.rb --template-dir /home/USER/pwoss/path/to/the/Wiki/public/templates/ --css"
Restart=on-abort
[Install]
WantedBy=multi-user.target
sudo systemctl daemon-reload && sudo systemctl restart gollum
If you want to run the Wiki on your network/server.
sudo nano /etc/nginx/sites-available/gollum
upstream gollum_app_webrick_server {
server localhost:4567;
}
server {
listen 4444;
server_name your-ip;
# return 301 https://your-domain$request_uri;
location / {
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
proxy_set_header X-Scheme $scheme;
proxy_redirect off;
proxy_pass http://gollum_app_webrick_server;
}
}
sudo ln -s /etc/nginx/sites-available/gollum /etc/nginx/sites-enabled/
sudo systemctl restart nginx.service
If you have UFW installed.
sudo ufw allow 4444/tcp
Create the file custom.css
in your root repository.
touch ~/your/wiki/path/custom.css
Change the size of the wiki.
nano ~/your/wiki/path/custom.css
.container-lg {
max-width: 70%;
}
sudo systemctl restart gollum.service