Guidance to troubleshooting common issues and quesitons in Dribdat can be found here. For more technical references, see the README.
There is an Embed button in the event admin which provides you with code for an IFRAME that just contains the hexagrid. If you would like to embed the entire application, and find it more intuitive to hide the navigation, add ?clean=1
to the URL. To also hide the top header, use ?minimal=1
.
The Backboard project is our new alternative front-end, that invokes the dribdat API to visualize data from the platform.
If your CMS supports RSS feeds, you can also embed the latest activities using this format. Check the About page for the link.
Some Bootswatch themes do not play well with the navbar-light component used in our layout (nav.html
). Override the styles by hand using the DRIBDAT_CSS_URL
environment variable.
The first user account on the system gets automatically promoted to admin.
If you are locked out of the administration, run ./manage.py shell
on the console.
You can then promote any user to admin and/or reset the password of a user called "admin" like this:
u = User.query.filter(User.username=='admin').first()
u.is_admin = True
u.set_password('Ins@nEl*/c0mpl3x')
u.save()
To get client keys, go to the Slack API, Azure portal, or add the GitHub App to your account or organization. You can also use custom OAuth 2 provider if you provide all external registration URLs.
Cannot determine SSO callback for app registration? Try this:
<my server url>/oauth/<my provider>/authorized
Where the provider is slack
, mattermost
, .. as configured in OAUTH_TYPE
Open a manage.py shell
and run a command like this to remove all non-admin, inactive, non-SSO users with zero drib-scores:
from dribdat.user.models import User
for pp in User.query.filter_by(is_admin=False, active=False, sso_id=None):
if pp.activity_count == 0 and len(pp.roles) == 0 and len(pp.posted_challenges()) == 0: pp.delete()
Here is an example of how to configure your own S3 provider (i.e. not Amazon) for serving files:
S3_BUCKET=my-bucket-a1bc2d3f4g
S3_FOLDER=dribdat4uri
S3_ENDPOINT=https://my-bucket-a1bc2d3f4g.s3.provider.com
S3_HTTPS=https://my-bucket-a1bc2d3f4g.https.provider.com
S3_KEY=BC7CH3CNMVERYSECRET
S3_SECRET=abCdEfGhIjKlMnOpQr
Make sure to provide an HTTPS link, as normally you would like to be able to show uploaded files, not just store them. This may require setting permissions and CORS settings accordingly with your provider. We have tested this set up with Linode Object Storage, Exascale, Bucketeer and others.
In local deployment, you will need to upgrade the database using ./manage.py db upgrade
.
On Heroku, a deployment process called Release runs automatically. Note also the Socialize process which is used for refreshing user profiles.
If you get errors like ERROR [alembic.env] Can't locate revision identified by 'aa969b4f9f51', your migration history is out of sync. You can set FORCE_MIGRATE
to 1 when you run releases, however changes to the column sizes and other schema details will not be deployed. Instead, it is better to verify the latest schema specifications in the migrations
folder, fix anything that is out of sync, and then update the alembic version, e.g.:
alter table projects alter column webpage_url type character varying(2048);
insert into alembic_version values ('7c3929047190')
A handy parameter is --sql
which shows just the SQL code you can also apply manually to fix your database. See also further instructions in the force-migrate.sh
script.
There were issues in upgrading your instance that may require a manual SQL entry. Try running these commands in your psql
console:
ALTER TYPE activity_type ADD VALUE 'boost';
ALTER TYPE activity_type ADD VALUE 'review';
Run manage.py socialize users
to restore the profile images. This is due to a change in the way they are stored, to make the profile more flexible.
Some development scenarios and OAuth testing requires SSL. To use this in development with self-signed certificates (you will get a browser warning), start the server with ./manage.py run --cert=adhoc
You can test SSO providers in this way by adding OAUTHLIB_INSECURE_TRANSPORT=true
to your environment (do not use in production!)
The project has so far mostly been developed on Arch, Fedora and Ubuntu Linux. Users on Alpine, BSD and other distributions are welcome to share their experience with us in the Issues. Some additional system packages are needed for a successful local (non-Docker) deployment.
E.g. for Alpine or Ubuntu (apt instead of apk):
apk add libxml2-dev libxslt-dev libffi-dev rust cargo
You are missing development headers for Python. For example, in Fedora Linux run:
sudo dnf install libffi-devel python3-devel gcc
On Ubuntu (apt
) or Alpine Linux (apk
), the command will look more like this:
sudo apk add libffi-dev python3-dev gcc
Install the Poetry Export plugin (this may not be necessary in the near future), then run:
poetry export -f "requirements.txt" --output "requirements/prod.txt" --without-hashes
The following questions were originally compiled as part of the projects DINAcon nomination. You can contribute to additional social review of the project at AlternativeTo.
Live and production ready.
November 2015
OSI/FSD-approved free software license (MIT)
No
5
393
No
38 stars, 17 forks
Yes. We meet at least twice a year at events where we use, and further develop, this platform. There is a small group of people that has directly influenced, and continues to take an interest in, the course of this project. We have several online locations to share updates (notably on Open Collective, Mattermost, Discord and Slack).
Used at 50+ hackathons. The single largest installation has 750+ users.
Yes. Hackathon participations are not just coders, and non-technical users who would like to discover open source activities are an important prerogative for this project. The process of running creative events like hackathons, combining our experience in code, is something we have aimed to build into all parts of the tool to make the event format accessible to an even wider public.
Yes, there is a getting started page which can also be customized by the organisers. We have a community instance, where people can start their own events. To run your own instance of dribdat, there are clear installation instructions to follow.
Oleg and other people with experience in using the platform are available via various community channels to new users of dribdat. We regularly mentor new users in getting started. There is also a hosted version of the platform which we can set up to get hackathons going quickly. And a reasonably active forum.
The Hack Code of Conduct, which we have applied to events for the past 3 years, is now in dribdat by default to help facilitate inclusive events.
There are hackathons happening all over the world every weekend. Countless more collaborative online "hacking" events happen every day in companies, institutions and the civil society. Each of them generates interest, activity, networking and new initiatives. While several hackathon platforms contend to "lead the market", we are one of a handful of open source alternatives, most notably HackDash and Sparkboard - which operate in a SaaS model.
Please visit our OpenCollective, where we are currently focusing our fundraising and transparent budgeting.
Currently we accept sponsoring and distribute it within the project, but do not charge a licensing fee of any kind. There is a strong, recurrent interest from companies in using dashboards similar to this one for tracking internal activities above and beyond hackathon-type events. Several commercial models come to mind: the original motivation for the project came out of a hackathon sponsored by Swisscom, a company that champions innovation culture. We are inspired us to pursue an organic and grassroots business model that benefits a wide variety of "start-up" initiatives.
Hackathons have become a useful instrument to see critically beyond the veil of pragmatic utility in Information Technologies, and have been embraced by the most disruptive companies and organisations around the world as a vehicle for positive change. By imbuing a software project with the ethics and values of hackathons, we can scale these experiments from our local community to many other corners of the world and many domains of creative collaboration.
We wouldn't have our own platform to hack the meta-side of hackathons, and that would be a shame. We could go back to using wikis and repo organisations, with all the constraints and loss of user friendliness that entails.
In addition to the low thousands of user accounts and hundreds of projects across the different installations (these are visible to administrators in the dashboard), many dribdat instances have "open analytics": scroll down to the bottom of the page (for example, on hack.opendata.ch) and click Analytics.