Wikimusic - Manual & Documentation

wikimusic and all of its source code are free software, licensed under the GNU Affero General Public License v3 (or newer at your convenience).

https://www.gnu.org/licenses/agpl-3.0.nl.html

The documentation and examples, including this document, which are provided with wikimusic, are all licensed under the GNU Free Documentation License v1.3 (or newer at your convenience).

https://www.gnu.org/licenses/fdl-1.3.html

This project adheres to the jointhefreeworld code of conduct. Find it here:

https://jointhefreeworld.org/blog/articles/personal/jointhefreeworld-code-of-conduct/index.html

In summary, we foster an inclusive, respectful, and cooperative environment for all contributors and users of this free software project. Inspired by the ideals of the GNU Project, we strive to uphold freedom, equality, and community as guiding principles. We believe that collaboration in a community of mutual respect is essential to creating excellent free software.

Contributing to free software is a uniquely beautiful act because it embodies principles of generosity, collaboration, and empowerment.

We welcome everyone to feel invited to the wikimusic Project, and encourage active contribution in all forms, to improve it and/or suggest improvements, brainstorm with me, make it more modular/flexible, etc, feel free to contact me <jjbigorra@gmail.com> to chat, discuss or report feedback.

Find here the Backlog and Kanban boards for wikimusic: https://lucidplan.jointhefreeworld.org/tickets/wikimusic

Bewaking is a nice library to help you secure your web applications with Guile Scheme: https://codeberg.org/jjba23/bewaking

With bewaking we use secure tokens encrypted and stored in secure cookies (for browsers) and headers (for REST API)

If you want to be a super user in wikimusic your token will need to have the wikimusic:modify-permissions permission, effectively meaning you can give yourself and others all wanted permissions and do everything.

See more of the permissions here:

• wikimusic:song-create
• wikimusic:song-delete
• wikimusic:artist-create
• wikimusic:artist-delete
• wikimusic:genre-create
• wikimusic:genre-delete
• wikimusic:user-create
• wikimusic:user-delete
• wikimusic:modify-permissions

Wikimusic requires an authenticated session for performing administrative tasks such as creating/deleting tickets and projects.

Upon starting a blank new wikimusic deployment you will have no users in the database. Check in db/migration and edit the password field and salt, or add more users. An important note is that currently the passwords should NOT contain any special characters (letters and numbers are OK).

Then do a guix shell -m manifest.scm -- art migrate up user to add your users.

If running locally, it's recommended to use localhost instead of 127.0.0.1 as this will work better with the authentication/authorization and other cookies.

-—

If you are thinking of running Wikimusic yourself and hosting it on your own here follow some tips.

Firstly, make sure you use the Guix package manager, whether as a standalone distro (Guix system) or on top of any other GNU/Linux distribution.

I include a manifest.scm in the repo so that it's easy to run the project if you use the Guix package manager.

If you want to run without Guix you should check that manifest.scm anyway since it will give you exactly the packages that you need.

For running wikimusic yourself, you'll need to define and load a module called (wikimusic env) where you add some required environment variables. I recommend in the root of the project create a env.scm and exclude it from Git.

(define-module (wikimusic env))

(define-public encryption-key "a2ebe4c5-4a78-4490-af83-cfb05a285bf9")

(define-public signing-key "8d3a5bcc-973e-4f80-aa3d-33be33d6631c")

(define-public pingwing-url
  "my-pingwing-host")

(define-public pingwing-basic-auth-user
  "my-user")

(define-public pingwing-basic-auth-password
  "my-password")

Pingwing is a mail and notification solution written in Guile Scheme and also part of the jointhefreeworld project. It's used in WikiMusic for password resets, among other notifications. Find more about it here: https://codeberg.org/jjba23/pingwing

Then, you will need a database to be present in the root folder of the project (alongside app, lib, etc.).

Wikimusic uses SQLite by default but is also compatible with PostgreSQL and MySQL.

You can automate the creation of the database and the enabling of WAL mode for concurrent writes with make init-db.

You should then look at db/migration folder and edit the migration for the user table to your liking.

Then do a guix shell -m manifest.scm -- art migrate up user to add your users.

If you are hacking away at the project, I would suggest using make dev since this will effectively run the project with hot-reloading capabilities and it will use the default artanis.conf where we configure hostname, db path, etc.

If you are hosting this for production, I would suggest running Wikimusic as a Shepherd service/daemon. You can alternatively just feel free to do this any other way, I recommend using the manifest.scm . Check the Makefile for more.

Here follows an example of a Guix (Shepherd service):

(define-module (wolk-jjba wikimusic)
  #:use-module (gnu)
  #:use-module (guix))

(use-service-modules shepherd)

(define-public (wolk-jjba-wikimusic-service config)
  (list (shepherd-service (documentation "Run wikimusic as a daemon")
                          (provision '(wikimusic))
                          (requirement '())
                          (start #~(make-forkexec-constructor '("make"
                                                                "production-server")
                                    #:directory
                                    "/etc/wikimusic/job-clone/wikimusic/trunk"
                                    #:environment-variables '("GUILE_LOAD_PATH=/run/current-system/profile/share/guile/site/3.0"
                                                              "GUILE_DBD_PATH=/run/current-system/profile/lib"
                                                              "C_INCLUDE_PATH=/run/current-system/profile/include"
                                                              "GUILE_LOAD_COMPILED_PATH=/run/current-system/profile/lib/guile/3.0/site-ccache:/run/current-system/profile/share/guile/site/3.0"
                                                              "LIBRARY_PATH=/run/current-system/profile/lib"
                                                              "GIT_SSL_NO_VERIFY=1"
                                                              "PATH=/run/privileged/bin:/run/current-system/profile/bin:/run/current-system/profile/sbin")))
                          (stop #~(make-kill-destructor))
                          (auto-start? #t)
                          (respawn? #t))))

(define-public wolk-jjba-wikimusic-service-type
  (service-type (name 'wikimusic)
                (description "Run wikimusic as a daemon")
                (extensions (list (service-extension
                                   shepherd-root-service-type
                                   wolk-jjba-wikimusic-service)))
                (default-value '())))

We believe creating accessible websites for everyone, including people with disabilities, is crucial for equality, helps provide a good user experience.

Wikimusic chooses lots of its UI to appeal to the widest public possible by default, but is very configurable to allow extensibility.

Find the documentation for Artanis here: https://www.gnu.org/software/artanis/manual/

GNU Artanis is the first production-level modern Web framework of Scheme programming language.

It is designed and maintained to be robust, fast, and easy to use for professional web development.

Here lies not just a framework, but a canvas where your ideas take flight with remarkable speed and grace. Artanis isn't about wrestling with complexity; it's about the joy of creation.

It's about harnessing the power of a robust and mature language to build something truly your own, something beautiful, nimble, flexible, powerful, efficient, understandable and maintainable. GNU Artanis was Certificated as Awesome Project at 2013 Lisp in summer projects.

One day, the folks at GNU were discussing what language they would write the GNU website in - and many chose Python. But I found that strange, because the official extension language of GNU is GNU Guile. And I wondered aloud - why not start a brand new project to provide a web framework written with GNU Guile? To which RMS said, "It's cool, I like this idea."

But at that time, it was just an idea without a plan.

Fortunately, a few months later, the Guile community held a hack-potluck to celebrate Guile2 turning two - which is a contest to write a cool program in a few weeks. And so, Artanis was born. History

February 2013 - Artanis born at the GNU Guile hack-potluck. 2013 - Artanis submitted to "Lisp In Summer Projects" contest. Received "Certificated awesome project award" in 2014. 1st January, 2015 - the first stable version Artanis-0.0.1 was released. 19th January, 2015 - offers Artanis to FSF/GNU, and RMS inducts it as an official GNU project. Artanis becomes GNU Artanis. 29 December 2021 - GNU Artanis donates to HardenedLinux community to connect with product environment more tightly.