Package: aa-simplewiki
SimpleWikiA simple wiki plugin for alliance auth. It supports multiple pages with different sections. Every page and every section can have their own icon. Written in Python with Django.ContentsCurrent FeaturesTODOPlannedScreenshotsInstallationAlliance Auth ProductionNon-Docker VersionDocker VersionAlliance Auth DevelopmentUsagePermissionsSupportCurrent FeaturesCreate custom wiki menus with dropdowns plus different sections on each menuAdd an icon next to menus or sectionsEdit pages on the admin panel withmarkdownSupport for all major GitHub markdown featuresSupport for videos (YouTube and Vimeo)Support for alerts and Google DriveSearch function: Search across all wiki menus and sectionsPermission system:Editor permissions can be added to single users or groups via the admin panelAlliance Auth groups are synced to simplewiki: Certain pages can only be seen by a specific groupMultiple groups support: As long as the user is in any of the required groups, they can access the menuEditor interfaceUsers with editor permission can create, edit and delete custom menus and sections (editor_access)Users with editor permission see edit and delete buttons above all sections (editor_access)Change menu position's with a drag and drop systemTODO:Quality-of-life updatesImplement better loggingImprove code documentationMarkdownButtonsPlannedAdd translations forGermanSpanishChineseRussianKoreanFrenchItalianActive devs:MeowosaurusScreenshotsSearchAdmin PanelInstallationAlliance Auth ProductionNon-Docker Version1.) Install the pip package viapip install aa-simplewiki2.) Addsimplewikito yourINSTALLED_APPSin your projectslocal.py3.) Restart your server, then run migrations and collectstaticDocker Version1.) Please make sure you followed the custom docker-image tutorialhere:2.) Edit yourconf/requirementsand add the following lineaa-simplewiki(Checkhttps://pypi.org/project/aa-simplewiki/for different versions!)3.) Addsimplewikito yourINSTALLED_APPSin your projectslocal.py4.) Start your serverdocker compose --env-file=.env up -d5.) Rundocker compose exec allianceauth bash7.) Runauth migrate8.) Runauth collectstaticAlliance Auth DevelopmentMake sure you have installed alliance auth in the correct way:https://allianceauth.readthedocs.io/en/latest/development/dev_setup/index.html1.) Download the repogit clone https://github.com/meowosaurus/aa-simplewiki2.) Make sure it's under the root folderaa-dev, not undermyauth3.) Change directory intoaa-devaand runpip install -e aa-simplewikiImportant: If you are getting an error saying thatsimplewikiis not installed after runningpip install -e aa-simplewiki, delete thesetup.pyfile in the aa-simplewiki root directory and try again.4.) Addsimplewikito yourINSTALLED_APPSin your projectslocal.py5.) Change directory intomyauth6.) Make migrations withpython manage.py makemigrations7.) Migrate withpython manage.py migrate8.) Restart auth withpython manage.py runserverUsageCheck out our wiki on GitHub:https://github.com/meowosaurus/aa-simplewiki/wiki1.) Go to{your_auth_url}/admin-> SimpleWiki -> Add Menu Item2.) Give it a title, an index (menu items are sorted by their index from low to high) and a name (the name is the name in the url) and hit save.3.) Go to{your_auth_url}/admin-> SimpleWiki -> Add Page Item4.) Give it a title, a menu page (this is the menu page it will be under), an index (ordered from low to high) and a content description. This description will be the main content and you can use HTML. Hit save.5.) Go back to your main auth page, go under Wiki and you've created your first menu and page.PermissionsPermAdmin SiteAuth Sitebasic_accessNoneCan view all wiki pageseditor_accessNoneCan create, edit and delete wiki pages and menusCommandsMigrate all data from 1.0.x to 1.1.1 to use new model system:python manage.py simplewiki_migrate_v1_1Migrate section data from 1.1.1 and later to 1.1.3 to add author details:python manage.py simplewiki_migrate_v1_3DependenciesAlliance Authallianceauth-app-utilsMistunejQueryNestableSupportOn Discord: meowlicious