Skip to content

Instantly share code, notes, and snippets.

@markasoftware
Last active March 31, 2025 17:06
Show Gist options
  • Save markasoftware/f5b2e55a2c2e3abb1f9eefcdf0bfff45 to your computer and use it in GitHub Desktop.
Save markasoftware/f5b2e55a2c2e3abb1f9eefcdf0bfff45 to your computer and use it in GitHub Desktop.
OpenProject Enterprise mode for free
############ REPLACE app/models/enterprise_token.rb in the source code with this file! ################
############ also be sure to RESTART OpenProject after replacing the file. ################
############ it doesn't show that enterprise mode is enabled in the settings, but all ################
############ enterprise mode features, such as KanBan boards, are enabled. ################
#-- copyright
# OpenProject is an open source project management software.
# Copyright (C) 2012-2023 the OpenProject GmbH
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License version 3.
#
# OpenProject is a fork of ChiliProject, which is a fork of Redmine. The copyright follows:
# Copyright (C) 2006-2013 Jean-Philippe Lang
# Copyright (C) 2010-2013 the ChiliProject Team
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 2
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#
# See COPYRIGHT and LICENSE files for more details.
#++
class EnterpriseToken < ApplicationRecord
class << self
def current
RequestStore.fetch(:current_ee_token) do
set_current_token
end
end
def table_exists?
connection.data_source_exists? table_name
end
def allows_to?(action)
true
end
def active?
true
end
def show_banners?
false
end
def set_current_token
token = EnterpriseToken.order(Arel.sql('created_at DESC')).first
if token&.token_object
token
end
end
end
validates :encoded_token, presence: true
validate :valid_token_object
validate :valid_domain
before_save :unset_current_token
before_destroy :unset_current_token
delegate :will_expire?,
:subscriber,
:mail,
:company,
:domain,
:issued_at,
:starts_at,
:expires_at,
:reprieve_days,
:reprieve_days_left,
:restrictions,
to: :token_object
def token_object
load_token! unless defined?(@token_object)
@token_object
end
def allows_to?(action)
true
end
def unset_current_token
# Clear current cache
RequestStore.delete :current_ee_token
end
def expired?(reprieve: true)
false
end
##
# The domain is only validated for tokens from version 2.0 onwards.
def invalid_domain?
false
end
private
def load_token!
@token_object = OpenProject::Token.import(encoded_token)
rescue OpenProject::Token::ImportError => e
Rails.logger.error "Failed to load EE token: #{e}"
nil
end
def valid_token_object
errors.add(:encoded_token, :unreadable) unless load_token!
end
def valid_domain
errors.add :domain, :invalid if invalid_domain?
end
end
@mmviamm
Copy link

mmviamm commented Dec 29, 2024

Thank you all, i got working on v15.1.0, docker one container per process.
I used @jiriks74 suggestion but i encountered a permission error in the container, because the default user is app not root. To fix this, i added -u root flag.

docker exec -u root -t openproject-web-1 /usr/bin/curl "https://gist.githubusercontent.com/markasoftware/f5b2e55a2c2e3abb1f9eefcdf0bfff45/raw/148c5067e30eae04f96e3233144b4404f70ade47/enterprise_token.rb" -o /app/app/models/enterprise_token.rb && docker restart openproject-seeder-1 openproject-web-1

However, in my case i had an issue with openproject-web-1, after 53sec it remained unhealthy util autoheal killed it for restart.
During the first initialization, web container needs at least 3 mins to boot and become healthy, so i changed docker-compose.yml and add volume as suggested by @perexwi here:

...
services:
  ...
  web:
    ...
    volumes:
      - : "./enterprise_token.rb:/app/app/models/enterprise_token.rb:ro"
...

Make sure to add the volumes line properly. After that, I rebuilt the containers:

docker compose  up -d --build
# if you use http add env var before:
OPENPROJECT_HTTPS=false docker compose  up -d --build

Finally, verify that the file has been added correctly by using:

docker exec -u root -it openproject-web-1 cat /app/app/models/enterprise_token.rb

Thant you all.

@hyprem
Copy link

hyprem commented Jan 5, 2025

It seems it worked for me just one question. Does it enable the kanban boards only or other features such as adding a custom openid provider (only in enterprise edition)
https://www.openproject.org/docs/system-admin-guide/authentication/openid-providers/#custom-openid-connect-provider
Is there something to change to enable these enterprise add-ons?

@piradata
Copy link

piradata commented Jan 5, 2025

it enables everything @hyprem

@scalenow
Copy link

scalenow commented Jan 6, 2025

It seems it worked for me just one question. Does it enable the kanban boards only or other features such as adding a custom openid provider (only in enterprise edition) https://www.openproject.org/docs/system-admin-guide/authentication/openid-providers/#custom-openid-connect-provider Is there something to change to enable these enterprise add-ons?

The instructions to configure SSO on openproject website is incorrect.I am struggling to configure,once sorted will post here

@rexfordnyrk
Copy link

@markasoftware @hyprem @mmviamm @piradata
Can any of you please confirm if the 20-user limit @scalenow mentioned is the same for you in the enterprise version? I want to try this but I need to know first.
Thank you.

@rexfordnyrk
Copy link

So I was able to get this working fine. however I am yet to confirm the user limit reported by @scalenow

@scalenow
Copy link

@rexfordnyrk user limit is user specific.You should not have any limits

@hyprem
Copy link

hyprem commented Jan 14, 2025

I have not reached the user limit as of now, however the token still works with the latest version and also azure integration works without any problem.

@rexfordnyrk
Copy link

@scalenow Please what do you mean by the user limit being specific? in what conditions do they apply.

@hyprem thank you for the feedback. I am also working on LDAP integration atm

@scalenow
Copy link

@rexfordnyrk @hyprem there are no user limit ,please ignore my remarks

@rexfordnyrk
Copy link

Sure, Thank you.

@derguenner
Copy link

with openproject 15.1.1 it is working for me
just added this line in docker-compose file:

    volumes:
      - /mnt/data/openproject/enterprise_token.rb:/app/app/models/enterprise_token.rb:ro

@VladislavBabarikov
Copy link

with openproject 15.1.1 it is working for me just added this line in docker-compose file:

    volumes:
      - /mnt/data/openproject/enterprise_token.rb:/app/app/models/enterprise_token.rb:ro

TXH! working

@Artifex04
Copy link

Artifex04 commented Feb 3, 2025

Does this work for 15.2.0? as soon as I apply this:
volumes:
- /mnt/data/openproject/enterprise_token.rb:/app/app/models/enterprise_token.rb:ro

I get a black screen after getting to the log in page successfully, but once I log in, just black.
I have placed the enterprise_token.rb inside /mnt/data/openproject/

If I remove the volumes part from docker-compose.yml, openproject works again but of course without the premium stuff. I'm totally new to this software so I'm not sure if the error is on my end or just that the version I installed is too new for tis fix to work. If someone knows more I'd greatly appreciate any input on what I might be doing wrong.

@Artifex04
Copy link

Does this work for 15.2.0? as soon as I apply this: volumes: - /mnt/data/openproject/enterprise_token.rb:/app/app/models/enterprise_token.rb:ro

I get a black screen after getting to the log in page successfully, but once I log in, just black. I have placed the enterprise_token.rb inside /mnt/data/openproject/

If I remove the volumes part from docker-compose.yml, openproject works again but of course without the premium stuff. I'm totally new to this software so I'm not sure if the error is on my end or just that the version I installed is too new for tis fix to work. If someone knows more I'd greatly appreciate any input on what I might be doing wrong.

OK, I managed to fix it, I rolled back to ver 15.1.1 but had the same issue, in the end it was a matter of permissions. It took a while but I managed to solve it manually finding the docker container folder and replacing it there by hand, then granting full read/write permissions to other users. I then upgraded back to 15.2.0 and can confirm that it works.(had to redo the process of finding the new long string named folder to place it in).

In my case adding the volumes under web didn't work, but manually replacing the file worked for me and has been working through full server restarts. I don't seem to get that unhealthy web problem some people mentioned above. Just leaving this here in case it helps somebody else.

@AndyCyberSec
Copy link

For those running a docker container you can runt this command (and add it to a cron job if you're interested):

docker exec -t openproject-web-1 /usr/bin/curl "https://gist.githubusercontent.com/markasoftware/f5b2e55a2c2e3abb1f9eefcdf0bfff45/raw/148c5067e30eae04f96e3233144b4404f70ade47/enterprise_token.rb" -o /app/app/models/enterprise_token.rb && docker restart openproject-seeder-1 openproject-web-1

EDIT: this is for the official One container per process setup.

add -u root after exec otherwise you get permission error. I also stopped openproject-autoheal-1, not sure if this is needed

@OliverKarla
Copy link

This is not working for newest 15.3 anymore? I installed on premise community version and when I change that file, app on server becomes unresponsive and I have to remove everything and reinstall. Just changing this file back does not work. OS is ubuntu 22.04

@perexwi
Copy link

perexwi commented Mar 6, 2025

Working with OpenProject 15.3.2

@duy12i1i7
Copy link

Working with OpenProject 15.3.2

how can u active with OpenProject 15.3.2, I installed OpenProject 15.3.2 on ubuntu 20.04, but I don't know how to use this script for active enterprise mode :<, plz help me

@scalenow
Copy link

@duy12i1i7 look for enterprise_token.rb and replace the content on top

@perexwi
Copy link

perexwi commented Mar 13, 2025

Working with OpenProject 15.3.2

how can u active with OpenProject 15.3.2, I installed OpenProject 15.3.2 on ubuntu 20.04, but I don't know how to use this script for active enterprise mode :<, plz help me

How did you install OpenProject, Docker, packages, Kubernetes, etc.? In all cases, you'll need to replace the enterprise_token.rb script, but you'll need to do different things depending on your installation method. Let me know first to help you 🙃

@smarthomecoder
Copy link

I also installed as standalone under Ubuntu, pasted the code in the token.rb file and then whole openproject crashed. Can that be a result of not shutting down the right processes before editing the file? Maybe I forgot to turn of something !? Also I installed the community version that you can download.

@perexwi
Copy link

perexwi commented Mar 15, 2025

@smarthomecoder @duy12i1i7 I installed the package version under a fresh install of Ubuntu 20.04 (The same you use) and works just perfect. I noticed that you write "pasted the code in the token.rb" maybe did you replace the wrong file? you need to replace the /opt/openproject/app/models/enterprise_token.rb file, not the token.rb file. Can you confirm what file did you replace?

@lockdlock
Copy link

Working with OpenProject 15.4.1?

@duy12i1i7
Copy link

@smarthomecoder @duy12i1i7 I installed the package version under a fresh install of Ubuntu 20.04 (The same you use) and works just perfect. I noticed that you write "pasted the code in the token.rb" maybe did you replace the wrong file? you need to replace the /opt/openproject/app/models/enterprise_token.rb file, not the token.rb file. Can you confirm what file did you replace?

Oh I see how to use this on newest version, thanks bro

@benmi3
Copy link

benmi3 commented Mar 21, 2025

It is working on OpenProject 15.4.1

@smarthomecoder
Copy link

smarthomecoder commented Mar 24, 2025

thx for the help! did it again, step by step and now it works.

@antoniolago
Copy link

For helm installations

  1. Add configmap with this file content in it:
apiVersion: v1
kind: ConfigMap
metadata:
  name: enterprise-token-config
  namespace: openproject
data:
  enterprise_token.rb: |
    <file content here>
    
  1. Add helm values:
  extraVolumes:
     - name: enterprise-token-volume
       configMap:
         name: enterprise-token-config
   extraVolumeMounts:
     - name: enterprise-token-volume
       mountPath: /app/app/models/enterprise_token.rb
       subPath: enterprise_token.rb
       readOnly: true
   
 

@gelt00
Copy link

gelt00 commented Mar 27, 2025

I have a question, my enterprise demo version only has 10 users, is there any way to adjust it to 20-25?

@OPiElix
Copy link

OPiElix commented Mar 31, 2025

works for 15.4.2. Thanks !!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment