Arachnidium

Installatie

  1. Zoek een homeserver: Dit kan elke computer met een internetverbinding zijn, zoals een oude laptop. Momenteel zijn er vooraf gebouwde releases beschikbaar voor x64 Windows en Linux. Indien u ondersteuning nodig heeft voor ARM of Mac, dient u de repository te klonen en het programma vanuit de broncode uit te voeren.
  2. Download de software: Download op uw homeserver het portable archief voor uw systeem via de sectie 'Releases'.
  3. Start de applicatie: Pak het archief uit en start Arachnidium.exe (Windows) of Arachnidium (Linux).
  4. Installeer de WireGuard-client: Installeer de client op uw apparaat (beschikbaar voor Android | iOS).
  5. Voeg het VPN-preset toe: Gebruik hiervoor de QR-code die in Arachnidium wordt weergegeven, of maak gebruik van het automatisch gegenereerde wireguard.cfg-bestand.
  6. Netwerkconfiguratie: Wanneer u de proxy buiten uw eigen wifi-netwerk wilt gebruiken, moet u uw netwerk configureren om binnenkomende VPN-verbindingen te accepteren. Hiervoor moet u UDP-poort 51820 van uw router doorsturen naar uw homeserver. Omdat dit proces per router en netwerk sterk verschilt, wordt aangeraden om zelf onderzoek te doen (zoek bijvoorbeeld op "port forward udp [model router]") of contact op te nemen met uw internetprovider.
  7. Certificaten instellen: Maak verbinding met de VPN en bezoek mitm.it in de browser van uw telefoon. Volg de instructies op die pagina nauwgezet om de certificaatautoriteit (Certificate Authority) in te stellen.

Let op: Indien u problemen ervaart, controleer dan of u alle bovenstaande stappen zorgvuldig heeft gevolgd en voer eerst zelf troubleshooting uit (bijvoorbeeld controleren op een foutieve netwerkconfiguratie). De ontwikkelaar heeft helaas niet de tijd om individuele hulpvragen via persoonlijke berichten te beantwoorden.

Configuratie

Arachnidium kan op twee manieren worden geconfigureerd:

  • Grafische interface (GUI): Wijzigingen in de GUI worden niet bewaard na een herstart.
  • defaults.json: Gebruik dit bestand voor permanente instellingen.

Wilt u Arachnidium zonder de grafische interface draaien? Zet dan de optie ENABLE_GUI op false in het bestand defaults.json.

Uitvoeren vanuit broncode

Om dit project direct vanuit de broncode te draaien zonder het eerst te bouwen (bijvoorbeeld voor ontwikkelingsdoeleinden of op niet-ondersteunde platforms), volgt u deze stappen:

  1. Installeer Python en uv.
  2. Installeer Bun.
  3. Kloon deze repository inclusief submodules (gebruik de vlag --recursive).
  4. Voer het volgende commando uit: uv run main.py.
  5. Open een tweede terminal, ga naar de map bun-api en voer uit: bun i, gevolgd door bun run index.ts.

Bijdragen

Bijdragen zijn welkom, maar houd rekening met het volgende: de ontwikkelaar zal dit project waarschijnlijk op de lange termijn niet intensief blijven onderhouden. Het project was bedoeld als experiment en is niet noodzakelijkerwijs bedoeld om uit te groeien tot een groot product. Pull requests worden incidenteel beoordeeld, maar issues zullen waarschijnlijk niet zelfstandig worden gesloten, tenzij het om kritieke fouten gaat.

Richtlijnen voor bijdragen:

  • Lees en volg de gebruiksaanwijzingen zorgvuldig voordat u een issue indient en voer eerst eigen troubleshooting uit.
  • Het gebruik van LLM's (Large Language Models) in ingediende code heeft bij voorkeur niet plaats. Indien u toch een LLM heeft gebruikt, wees hier dan transparant over: geef aan waar de LLM is ingezet en leg in eigen woorden uit wat de code doet.

Erkenningen

Dit project maakt gebruik van:

Herkomst van de naam De naam "Arachnidium" is een eerbetoon aan de vroegste webontwikkelaars uit de natuur. Het arachnidium is over het algemeen het deel van het lichaam van een spin dat verantwoordelijk is voor het produceren van webben. Daarnaast klinkt de naam simpelweg cool.