Tutorials and Howtos: Difference between revisions

From Alpine Linux
mNo edit summary
 
(303 intermediate revisions by 89 users not shown)
Line 1: Line 1:
[[Image:package_edutainment.svg|left|link=]]
{{Todo|This material has been re-organized..., but grouping should be checked: '''Howtos are smaller articles''' and '''tutorials are more detailed document'''}}
{{TOC right}}'''Welcome to Tutorials and Howtos, a place of basic and advanced configuration tasks for your Alpine Linux.'''
The tutorials are hands-on and the reader is expected to try and achieve the goals described in each step, possibly with the help of a good examples. The output in one step is the starting point for the following step.<br/>
Howtos are smaller articles explaining how to perform a particular task with Alpine Linux. We encourage people to send in both complete articles as well as requesting topics to be covered. If you think you have the skills and knowledge to write an Alpine Linux related article please do so on this Wiki. If you want to request a topic, please add your request in this page [[Talk:Tutorials_and_Howtos|Discussion]].


=System=
[[Image:package_edutainment.svg|right|link=]]
==Initial setup==
{{TOC left}}
* [[Setting up a basic vserver]]
'''Welcome to Tutorials and Howtos, a place of basic and advanced configuration tasks for your Alpine Linux.'''
* [[Alpine Linux package management#Local_Cache | How to enable APK caching]]
 
'''The tutorials are hands-on''' and the reader is expected to try and achieve the goals described in each step, possibly with the help of a good example. The output in one step is the starting point for the following step.
 
'''Howtos are smaller articles''' explaining how to perform a particular task with Alpine Linux, that expects a minimal knowledge from reader to perform actions.
 
'''IMPORTANT:''' contributions on those pages must be complete articles as well as requesting topics to be covered, don't override already made contributions. If you want to request a topic, please add your request in this page's [[Talk:Tutorials_and_Howtos|Discussion]].
 
 
{{Clear}}
 
= Howtos =
 
== Applications ==
 
=== Miscellaneous ===
 
* [[Ansible]] ''(Configuration management)''
 
=== Monitoring ===
 
* [[Awstats]] ''(Free log file analyzer)''
* [[Cacti: traffic analysis and monitoring network]] ''(Front-end for rrdtool networking monitor)''
* [[Cvechecker]] ''(Compare installed packages for Common Vulnerabilities Exposure)'' <!-- Monitoring and Security -->
* [[Linfo]]
* [[Obtaining user information via SNMP]] ''(Using squark-auth-snmp as a Squid authentication helper)'' <!-- Networking and Server, <== Using squark-auth-snmp -->
* [[PhpSysInfo]] ''(A simple application that displays information about the host it's running on)''
* [[Matomo]] ''(A real time web analytics software program)''
* [[Setting up A Network Monitoring and Inventory System]] ''(Nagios + OpenAudit and related components)'' <!-- draft, solution, Networking and Monitoring and Server -->
** [[Setting up NRPE daemon]] ''(Performs remote Nagios checks)'' <!-- Networking and Monitoring -->
* [[Setting Up Fprobe And Ntop|Ntop]] ''(NetFlow collection and analysis using a remote fprobe instance; for alpine 3.10-3.12 only)'' <!-- Networking and Monitoring -->
* [[Setting up lm_sensors]]
* [[SqStat]] ''(Script to look at active squid users connections)''
* [[Traffic monitoring]] <!-- Networking and Monitoring -->
** [[Setting up monitoring using rrdtool (and rrdcollect)]]
** [[Setting up traffic monitoring using rrdtool (and snmp)]] <!-- Monitoring -->
* [[Zabbix|Zabbix - the professional complete manager]] ''(Monitor and track the status of network services and hardware)''
* [[ZoneMinder video camera security and surveillance]]
 
=== Networking ===
 
* Alpine Wall ''(a new firewall management framework)''
** [[Alpine Wall]]
** [https://git.alpinelinux.org/awall/about/ Alpine Wall User's Guide]
** [[How-To Alpine Wall]]
* [[Freeradius Active Directory Integration]]
* [[GNUnet]]
* [[Setting up a OpenVPN server|OpenVPN server]] ''(Allowing single users or devices to remotely connect to your network)''
* [[OpenVSwitch]]
* [[Using Alpine on Windows domain with IPSEC isolation]]
* [[Configure a Wireguard interface (wg)|Wireguard]]
 
=== Telephony ===
 
* [[FreePBX|FreePBX on Alpine Linux]]
* [[Setting up Zaptel/Asterisk on Alpine]]
* [[Kamailio]] ''(SIP Server, formerly OpenSER)''
 
== Backup and data migration ==
 
* [[Alpine local backup|Alpine local backup (lbu)]] ''(Permanently store your modifications in case your box needs reboot)''
** [[Back Up a Flash Memory Installation]]
** [[Manually editing a existing apkovl]]
* [[Migrating data]]
* [[Rsnapshot]] - setting up periodic backups
 
== Desktop ==
 
* [[Alpine and UEFI]]
* [[Default applications]]
* Desktop cloud
** [[Nextcloud]] ''(Self hostable cloud suite - Dropbox Alternative)''
* [[Desktop environments and Window managers]] (overall information only)
* [[Printer Setup]]
* [[Remote Desktop Server]]
* Sound Systems
** [[ALSA]]
** [[PipeWire]]
** [[PulseAudio]]
* [[Configure action when power-button is pressed]]
* [[Suspend on LID close]]
* [[Alpine setup scripts#setup-xorg-base|Xorg Setup]]
* Wayland compositors:
** [[Sway]]
** [[River]]
** [[LabWC]]
 
== Networking ==
 
* [[Bluetooth]] - Instructions for installing and configuring Bluetooth
* [[Bonding]] - Bond (or aggregate) multiple ethernet interfaces
* [[Bridge]] - Configuring a network bridge
** [[Bridge wlan0 to eth0]]
* [[Configure Networking]]
* [[How to configure static routes]]
* Modem
** [[Using HSDPA modem]]
** [[Using serial modem]]
* [[mDNS]] - Howto implement multicast DNS resolution in Alpine.
* [[Multi ISP]] ''(Dual-ISP setup with load-balancing and automatic failover)''
* [[PXE boot]]
* Wi-Fi
** [[Wi-Fi|Connecting to a wireless access point]]
** [[How to setup a wireless access point]] ''(Setting up Secure Wireless AP w/ WPA encryption with bridge to wired network)''
* [[VLAN]]
 
== Other Architectures ==
 
=== ARM ===
 
* [[Alpine on ARM]]
 
==== Raspberry Pi ====
 
* [[Raspberry Pi Bluetooth Speaker|Raspberry Pi - Bluetooth Speaker]]
* [[Raspberry Pi|Raspberry Pi - Installation]]
* [[Linux Router with VPN on a Raspberry Pi|Raspberry Pi - Router with VPN]]
* [[Linux Router with VPN on a Raspberry Pi (IPv6)|Raspberry Pi - Router with VPN (IPv6)]]
* [[Classic install or sys mode on Raspberry Pi|Raspberry Pi - Sys mode install]]
* [[RPI Video Receiver|Raspberry Pi - Video Receiver]] ''(network video decoder using Rasperry Pi and omxplayer)''
* [[Raspberry Pi 3 - Browser Client]] - kiosk or digital sign
* [[Raspberry Pi 3 - Configuring it as wireless access point -AP Mode]]
* [[Raspberry Pi 3 - Setting Up Bluetooth]]
* [[Raspberry Pi 4 - Persistent system acting as a NAS and Time Machine]]
* [[How to set up Alpine as a wireless router|Raspberry Pi Zero W - Wireless router]] ''(Setting up a firewalled, Wireless AP with wired network on a Pi Zero W)''
 
=== IBM Z (IBM z Systems) ===
 
* [[s390x|s390x - Installation]]
 
=== PowerPC ===
 
* [[Ppc64le|Powerpc64le - Installation]]
 
== Post-Install ==
 
* [[CPU frequency scaling]]
* [[Repositories#Enabling_the_community_repository|Enable Community repository]] ''(Providing additional packages)''
* [[Enable Serial Console on Boot]]
* [[Enable Serial Console on Boot]]
* [[Upgrading to Edge]]
* [[Alpine Linux Init System|Init System (OpenRC)]] ''(Configure a service to automatically boot at next reboot)''
==Storage==
** [[Multiple Instances of Services|Init System - Multiple Instances of Services]]
* [[Setting up Logical Volumes with LVM]]
** [[Writing Init Scripts|Init System - Writing Init Scripts]]
* [[Setting up a software raid1 array]]
* [[Installing Oracle Java|Oracle Java (installation)]]
* [[iSCSI Target and Initiator Configuration]]
* [[IGMPproxy]]
* [[iSCSI Raid and Clustered File Systems]]
* [[Alpine Package Keeper|Package Management (apk)]] ''(How to add/remove packages on your Alpine)''
* [[High performance SCST iSCSI Target on Linux software Raid]]
** [[Comparison with other distros|Package Management - Comparison with other distros]]
==Networking==
* [[Running glibc programs]]
* [[Configure Networking]]
* [[Setting up a new user]]
* [[Howto Configure a Network Bridge]]
* [[Upgrading Alpine]]
* [[Howto Configure static routes]]
* [[Daily driver guide]]
* [[Using serial modem]]
 
* [[Using HSDPA modem]]
== Remote Administration ==
* [[Setting up Satellite Internet Connection]]
 
* [[Connecting to a wireless accesspoint]]
* ACF
* [[Using Alpine on Windows domain with IPSEC isolation]]
** [[Changing passwords for ACF|ACF - changing passwords]]
==Desktop Environment==
** [[Generating SSL certs with ACF]] <!-- Generating SSL certs with ACF 1.9 -->
* [[XFCE Setup]]
** [[setup-acf| ACF - setup]] ''(Configures ACF (webconfiguration/webmin) so you can manage your box through https)''
* [[Gnome Setup]]
* [[Setting up a SSH server]] ''(Using ssh is a good way to administer your box remotely)''
==Misc==
** [[HOWTO OpenSSH 2FA with password and Google Authenticator |OpenSSH 2FA]] ''(A simple two factor setup for OpenSSH)''
* [[Manually editing a existing apkovl]]
* [[OpenVCP]] ''(VServer Control Panel)''
* [[Changing passwords for ACF]]
* [[PhpMyAdmin]] ''(Web-based administration tool for MYSQL)''
* [[Formatting HD/Floppy/Other]]
* [[PhpPgAdmin]] ''(Web-based administration tool for PostgreSQL)''
* [[Back Up a Flash Memory Installation]]
* [[Webmin]] ''(A web-based interface for Linux system)''
 
== Server ==
 
* [[Hosting services on Alpine]] ''(Hosting mail, webservices and other services)''
* [[Hosting Web/Email services on Alpine]]
 
=== DNS ===


=Applications=
* [[DNSCrypt-Proxy]] ''Encrypt and authenticate DNS calls from your system''
==Networking==
* [[Setting up nsd DNS server]]
* [[Setting up a OpenVPN-server with Alpine]]
* [[Setting up a ssh-server]]
* [[Generating SSL certs with ACF]]
* [[Setting up traffic monitoring using rrdtool (and snmp)]]
* [[Setting up unbound DNS server]]
* [[Setting up unbound DNS server]]
* [[Setting up nsd DNS server]]
* [[TinyDNS Format]]
* [[Setting up a git repository server with gitolite and cgit]]
 
=== HTTP ===
 
* [[Apache]]
** [[Apache with php-fpm]]
** [[Setting Up Apache with PHP]]
** [[Apache authentication: NTLM Single Signon]]
* [[Darkhttpd]]
* [[Lighttpd]]
** [[Lighttpd Advanced security]]
** [[Setting Up Lighttpd With FastCGI]]
* [[Nginx]]
** [[Nginx as reverse proxy with acme (letsencrypt)]]
** [[Nginx with PHP]]
* Squid Proxy
** [[Obtaining user information via SNMP]] ''(Using squark-auth-snmp as a Squid authentication helper)'' <!-- Networking and Server, <== Using squark-auth-snmp -->
** [[Setting up Explicit Squid Proxy]]
** [[Setting up Transparent Squid Proxy]] ''(Covers Squid proxy and URL Filtering system)''
** [[SqStat]] ''(Script to look at active squid users connections)''
* [[Tomcat]]
 
==== Hostable Content ====
 
* [[DokuWiki]]
* [[Drupal]] ''(Content Management System (CMS) written in PHP)''
* [[Kopano]] ''(Microsoft Outlook compatible Groupware)''
* [[Mahara]] ''(E-portfolio and social networking system)''
* [[MediaWiki]] ''(Free web-based wiki software application)''
* [[Pastebin]] ''(Pastebin software application)''
* [[WordPress]] ''(Web software to create website or blog)''
 
=== IRC ===
 
* [[NgIRCd]] ''(Server for Internet Relay Chat/IRC)''
 
=== Mail ===
 
* Exim/Dovecot
** [[Small-Time Email with Exim and Dovecot]] ''(A simple configuration for your home network.)
** [[Setting up dovecot with imap and tls]]
* [[relay email to gmail (msmtp, mailx, sendmail]]
* [[Roundcube]] ''(Webmail system)''
* [[Setting up postfix with virtual domains]]
* Server protection
** [[Setting up clamsmtp]]
 
=== Other Servers ===


==VoIP==
* [[Chrony and GPSD | Chrony, gpsd, and a garmin LVC 18 as a Stratum 1 NTP source ]]
* [[Setting up Zaptel/Asterisk on Alpine]]
* [[Glpi]] ''(Manage inventory of technical resources)''
* [[Freepbx on Alpine Linux]]
* [[How to setup a Alpine Linux mirror]]
==Web==
* [[Setting up an NFS server|nfs-server]]
* [[Setting Up Lighttpd With FastCGI]]
* [[Odoo]]
* [[Apache authentication: NTLM Single Signon]]
* [[Configure OpenLDAP | OpenLDAP]] ''(Installing and configuring the Alpine package for OpenLDAP)''
===Webapps===
* [[Setting up a samba-ad-dc|samba-ad-dc]] ''(Active Directory compatible domain controller)''
* [[2600hz]] ''FreeSWITCH, Asterisk GUI web acces tool.''
* [[Setting up a Samba server|samba-server]] ''(standard file sharing)''
* [[Awstats]] ''Free log file analyzer.''
* [[Setting up Cacti|Cacti]]
* [[Drupal]] ''Content Management System (CMS) written in PHP.''
* [[EyeOS]] ''Cloud Computing Desktop.''
* [[FreePBX_V3]] ''FreeSWITCH, Asterisk GUI web acces tool.''
* [[Glpi]] ''Information Resource-Manager.''
* [[MediaWiki]] ''Free web-based wiki software application''
* [[Setting Up Fprobe And Ntop|Ntop]] ''NetFlow collection and analysis using a remote fprobe instance''
* [[Pastebin]] ''Pastebin software application''
* [[Phpizabi]] ''Social Networking Platform.''
* [[PhpPgAdmin]] ''Web-based administration tool for PostgreSQL.''
* [[Phpmyadmin]] ''Web-based administration tool for MYSQL.''
* [[Redmine]] ''Project management system ''
* [[Request-Tracker]] ''Ticket system''
* [[Roundcube]] ''Webmail system''
* [[Setting up Smokeping|Smokeping]] ''Network latency monitoring''
* [[Statusnet]] ''Microblogging Platform.''
* [[Sqstat]] ''Script to look active squid users connections.''
* [[Webmin]] ''A web-based interface for Linux system.''
* [[WordPress]] ''Web software to create website or blog. ''
* [[Setting up Zabbix|Zabbix]]
==Mail==
* [[Hosting services on Alpine]] ''(This applies to hosting mail, webservices and other services)''
** [[Setting up postfix with virtual domains]]
** [[Protecting your email server with Alpine]]
** [[Hosting Web/Email services on Alpine]]
==Misc==
* [[Multiple Instances of Services]]
* [[Setting up Transmission (bittorrent) with Clutch WebUI]]
* [[Setting up Transmission (bittorrent) with Clutch WebUI]]
* [[Freeradius Active Directory Integration]]
 
* [[Traffic monitoring]] ''(For Alpine Linux firewalls)''
=== Software development ===
* [[Setting up NRPE daemon]] ''(Performs remote Nagios checks)''
 
* [[Setting up lm_sensors]]
* [[Cgit]]
* [[Screen on console]]
* [[OsTicket]] ''(Ticket system)''
* [[Using espeak on Alpine Linux]]
* [[Patchwork]] ''(Patch review management system)''
* [[IPTV How To]]
* [[Redmine]] ''(Project management system)''
* [[Pllua]]
* [[Request Tracker]] ''(Ticket system)''
* [[Error message on boot: Address space collision: host bridge window conflicts with Adaptor ROM]]
* [[Setting up trac wiki|Trac]] ''(Enhanced wiki and issue tracking system for software development projects)''
=Complete Solutions=
 
== Storage ==
 
* [[Setting up disks manually|Disk setup (manual)]]
* [[Filesystems]]
** [[Burning ISOs]]
* [[Setting up iSCSI|iSCSI Setup]]
** [[iSCSI Raid and Clustered File Systems]]
** [[Linux iSCSI Target (TCM)|iSCSI Target (TCM)/LinuxIO (LIO)]]
** [[Linux iSCSI Target (tgt)|User space iSCSI Target (tgt)]]
* [[Setting up Logical Volumes with LVM|LVM Setup]]
** [[Setting up LVM on GPT-labeled disks|LVM on GPT-labeled disks]]
** [[Installing on GPT LVM|LVM on GPT-labeled disks (updated)]]
** [[LVM on LUKS]]
* RAID
** [[Raid Administration]]
** [[Setting up a software RAID array]]
* ZFS
** [[Root on ZFS with native encryption]]
** [[Setting up ZFS on LUKS]]
** [[Setting up ZFS with native encryption]]
** [[ZFS scrub and trim]]
 
== Virtualization ==
 
* [[Docker]]
* [[Installing Alpine in a virtual machine]]
** [[Install Alpine on VMware ESXi]]
* [[KVM]] ''(Setting up Alpine as a KVM hypervisor)''
* [[LXC]] ''(Setting up a Linux container in Alpine Linux)''
* [[QEMU]]
* Xen
** [[Xen Dom0]] ''(Setting up Alpine as a dom0 for Xen hypervisor)''
** [[Xen Dom0 on USB or SD]]
** [[Create Alpine Linux PV DomU|Xen DomU (paravirtualized)]]
** [[Xen LiveCD]]
** [[Xen PCI Passthrough]]
 
= Tutorials =
 
== Miscellaneous ==
 
* [[TTY_Autologin|TTY Autologin]]
* [[Kexec|Faster rebooting with kexec]]
* [[Dynamic Multipoint VPN (DMVPN)]] combined with [[Small Office Services]]
* [[DIY Fully working Alpine Linux for Allwinner and Other ARM SOCs]]
* [[Fault Tolerant Routing with Alpine Linux]]
* [[High Availability High Performance Web Cache]] ''(uCarp + HAProxy for High Availability Services such as Squid web proxy)''
* [[Linux iSCSI Target (TCM)]]
* [[ISP Mail Server 3.x HowTo]]] ''(Postfix+PostfixAdmin+DoveCot+Roundcube+ClamAV+Spamd - A full-service ISP mail server)''
* [[Replacing non-Alpine Linux with Alpine remotely]]
* [[Replacing non-Alpine Linux with Alpine remotely]]
* [[Fault Tolerant Routing with Alpine Linux]]
* [[Setting up A Network Monitoring and Inventory System]] ''(Nagios + OpenAudit and related components)'' <!-- draft -->
* [[ISP Mail Server HowTo]] ''(Postfix+PostfixAdmin+DoveCot+Roundcube+ClamAV+Spamd - A full-serivce ISP mail server)''
* [[Streaming Security Camera Video with VLC]]
** [[ISP Mail Server Upgrade 2.x]]
 
** [[ISP Mail Server 2.x HowTo]] ''(Beta, please test)''
== Newbie corner ==
* [[High Availability High Performance Web Cache]] ''uCarp + HAProxy for High Availability Services such as Squid web proxy''
 
= Drafts =
* [[How to get regular stuff working]] ''some notes on need-to-know topics''
Currently unfinished docs.
 
* [[Install Alpine on coLinux]]
== Servers ==
* [[Using Racoon for Remote Sites]]
* [[Setting up Transparent Squid Proxy]] ''(Covers Squid proxy and URL Filtering system)''
** [[Obtaining user information via SNMP]] ''(Using the Squark Squid authentication helper)''
* [[Setting up Streaming an Asterisk Channel]]
* [[Setting up A Network Monitoring and Inventory System]] ''((Nagios + OpenAudit and related components)''
* [[Intrusion Detection using Snort]] ''Installing and configuring Snort and related applications on Alpine 2.0.x''
* [[IP Accounting]] ''Installing and configuring pmacct for IP Accounting, Netflow/sFlow collector''
* [[Howto Setup a Wireless Access Point]] ''Setting up Secure Wireless AP w/ WPA encryption with bridge to wired network''
* [[Xen Dom0]] ''Setting up Alpine as a dom0 for Xen hypervisor''


= Obsolete Docs =
* [[Alpine production deploy]]
Those are candidates for rewriting/removal.
** [[Production Web server: Lighttpd|Production web server: Lighttpd‎‎]]
* [[Bootstrapping Alpine on Soekris net4xxx]]
** [[MySQL|Production database: MySQL]]
* [[Bootstrapping Alpine on PC Engines ALIX.3]]
** [[Production LAMP system: Lighttpd + PHP + MySQL‎‎]]
* [[Installing XUbuntu using Alpine boot floppy]]
* Alpine production monitoring
* [[Setting up trac wiki]]
** [[Cacti: traffic analysis and monitoring network]]
** [[Zabbix|Zabbix - the professional complete manager]]
* Kubernetes
** [[K8s]] Building a K8s Cluster on Alpine Linux

Latest revision as of 18:37, 30 March 2024

Todo: This material has been re-organized..., but grouping should be checked: Howtos are smaller articles and tutorials are more detailed document


Welcome to Tutorials and Howtos, a place of basic and advanced configuration tasks for your Alpine Linux.

The tutorials are hands-on and the reader is expected to try and achieve the goals described in each step, possibly with the help of a good example. The output in one step is the starting point for the following step.

Howtos are smaller articles explaining how to perform a particular task with Alpine Linux, that expects a minimal knowledge from reader to perform actions.

IMPORTANT: contributions on those pages must be complete articles as well as requesting topics to be covered, don't override already made contributions. If you want to request a topic, please add your request in this page's Discussion.



Howtos

Applications

Miscellaneous

Monitoring

Networking

Telephony

Backup and data migration

Desktop

Networking

Other Architectures

ARM

Raspberry Pi

IBM Z (IBM z Systems)

PowerPC

Post-Install

Remote Administration

Server

DNS

HTTP

Hostable Content

  • DokuWiki
  • Drupal (Content Management System (CMS) written in PHP)
  • Kopano (Microsoft Outlook compatible Groupware)
  • Mahara (E-portfolio and social networking system)
  • MediaWiki (Free web-based wiki software application)
  • Pastebin (Pastebin software application)
  • WordPress (Web software to create website or blog)

IRC

  • NgIRCd (Server for Internet Relay Chat/IRC)

Mail

Other Servers

Software development

Storage

Virtualization

Tutorials

Miscellaneous

Newbie corner

Servers

Retrieved from "https://wiki.alpinelinux.org/w/index.php?title=Tutorials_and_Howtos&oldid=26621"