After PRODUCTION install I get "WARN: bench is installed in editable mode!"

bkm · May 25, 2021, 6:38pm

I am using the install.py script to install everything with the following command:

sudo python3 install.py --verbose --production --user bkm_user --mariadb-version 10.5 --frappe-branch version-13 --erpnext-branch version-13

After the successful install, I get the warning about bench in editable mode.

I did NOT install it in developer mode and I did not enable developer mode, so there must be a problem with the install.py causing bench to install improperly.

This has happened on 3 server installs today (on 2 different VPS providers) all using the exact same install command (above).

Is there a way to fix this without re-installing bench and thus interrupting the production server?

BKM

peterg · May 25, 2021, 7:28pm

It sounds like install.py is installing bench as source from a repo.

I don’t think it’s necessarily a problem, but if you don’t like the warning I suspect it would go away if you installed it from PyPI.

There are some instructions on the project readme:

bkm · May 25, 2021, 7:33pm

Yeah, but that would interrupt an existing production server and I am not sure what other things might blow up if I were to go back and try to re-install bench.

Is there possibly an undocumented switch that I could use with the install.py command that would force it to install bench from PyPI?

BKM

peterg · May 25, 2021, 7:42pm

You’d be changing the frappe-bench executable package, but not your working directory (also called bench). In other words, it shouldn’t blow anything up, but of course always take backups, test on staging, etc., etc.

I don’t know much about the install.py process, but on quick search in the source code it doesn’t look like it.

kennethsequeira · May 26, 2021, 4:19pm

@revant_one has wonderfully explained the meaning of the error and how to switch envs in this thread:

Again, make sure to proceed cautiously

bkm · May 26, 2021, 4:42pm

@kennethsequeira , I am using the install.py script to do production installs and they are coming out this way. I am not a developer and am very unsure of how to get a valid install without this warning.

Could it be the developer team chose this way to install bench in order to get around having to otherwise install it 2 times (once from the user account and once as ‘sudo’)??

I do know that installing a production server in single steps, you have to install bench 2 times in order to get it to work. the second time as a sudo user. Otherwise things begin to fail when you start to use the system.

However, I am also not comfortable installing is such a manner that bench could be edited locally.

So, what is the correct way to install bench JUST ONE TIME and still have a valid working production install?

BKM

kennethsequeira · May 26, 2021, 5:37pm

Yeah, not sure why easy install is still using the manual method of installing bench whereas all the manual methods have moved to installation via pip

github.com

frappe/bench/blob/a7fec5c4f52d17b5ada18e7110d2bc8824f4d7f7/install.py#L287


      
          	if args.without_erpnext:
          		log("Initializing bench {bench_name}:\n\tFrappe Branch: {frappe_branch}\n\tERPNext will not be installed due to --without-erpnext".format(bench_name=bench_name, frappe_branch=frappe_branch))
          	else:
          		log("Initializing bench {bench_name}:\n\tFrappe Branch: {frappe_branch}\n\tERPNext Branch: {erpnext_branch}".format(bench_name=bench_name, frappe_branch=frappe_branch, erpnext_branch=erpnext_branch))
          	run_playbook('site.yml', sudo=True, extra_vars=extra_vars)
          
          
	if os.path.exists(tmp_bench_repo):
          		shutil.rmtree(tmp_bench_repo)
          
          

          
def clone_bench_repo(args):
          	'''Clones the bench repository in the user folder'''
          	branch = args.bench_branch or 'develop'
          	repo_url = args.repo_url or 'https://github.com/frappe/bench'
          
          
	if os.path.exists(tmp_bench_repo):
          		log('Not cloning already existing Bench repository at {tmp_bench_repo}'.format(tmp_bench_repo=tmp_bench_repo))
          		return 0
          	elif args.without_bench_setup:
          		clone_path = os.path.join(os.path.expanduser('~'), 'bench')
          		log('--without-bench-setup specified, clone path is: {clone_path}'.format(clone_path=clone_path))

Perhaps @gavindsouza or @abhishekbalam can help out with this.

peterg · May 26, 2021, 7:02pm

I’ve never had to install the bench executable twice, and in general in general it’s not a great idea to run pip commands with sudo. Where are you seeing this described as necessary?

bkm · May 26, 2021, 8:32pm

I ran into this several months ago. It first appeared in this post as steps #15 and #16 in the 22 steps to getting a working v13 beta server by @adals :

I even had to include it in my own rendition of the same process for making a v13 production server work otherwise I could not perform certain bench functions.

Then I had an offline conversation with another user/developer about this very problem and after much experimenting we could not find any other way to keep bench working properly for ALL functions unless we installed it twice!

There is a short discussion of that very problem in this post on yet another thread. Ultimately it was determined that you could either run bench in editable mode or else you had to install it twice. Neither is real;ly a satisfactory answer to running a secure version of bench. Here is the discussion on that part of the story:

So, @peterg if you have an alternate solution we are all waiting patiently for the fix.

BKM

bkm · May 26, 2021, 8:36pm

Probably because of this problem:

This is the reason I tagged you back on the correction you suggested about how best to install bench. Your method leave bench partially unusable unless it is installed twice as discussed in the above link.

Do you have an alternate solution?

BKM

bkm · May 26, 2021, 8:42pm

@kennethsequeira @peterg
Unless bench is additionally installed as a sudo user then you will never be able to use some of the following commands:

sudo bench setup lets-encrypt
This is needed in order to get your SSL certificate from Let’s Encrypt
sudo bench --force --site site1.local restore /path_to_sql_file
And this is the specified way for restoring a database to your ERPNext server.

There are a few others as well, but unless you have bench installed as a sudo user in addition to the regular user, you cannot perform several critical tasks. There must be a better way than using the bench in editable mode.

Still looking for a better solution. Does anyone have a fix for this?

BKM

Joseph_Marie_Alba1 · May 26, 2021, 10:11pm

I think this does not work anymore.

I simply install certbot, and use sudo certbot --nginx

I don’t know if pip3 install frappe-bench would work to install bench in your case, my guess is it will work. I also think uninstalling bench using pip is NOT needed in your case because you did not use pip to install bench in the first place.

I cannot verify my suggestion here because I no longer use the EASY INSTALL method anymore.

bkm · May 26, 2021, 11:27pm

Okay, but then how does one restore a database backup without the sudo version of bench?

BKM

Joseph_Marie_Alba1 · May 27, 2021, 12:47am

pip3 install of “frappe-bench” installs the “sudo bench”.
bench init “installs” the “frappe-bench” folder for a particular installation.

You only have one “sudo bench”
But you may do as many bench init as you like, depending on how may “unique” setups you need.

peterg · May 27, 2021, 1:39am

It sounds like a path issue. The fix will likely be slightly different depending on your distro and method of installing python3.

Do you still get the same problem if you use an absolute path to bench? Have you tried installing globally like @snv recommends in the thread you’ve linked? If those don’t work, you might also try passing your path variable to sudo (sudo env PATH=$PATH bench).

I’ve never seen this issue before, but that might be because of the distro I use. Ubuntu is a bit quirky in how it maintains environment variables in sudo commands, though I’ve heard the behavior changed at some point in version 19. CentOS does it differently still, I believe. Unfortunately, this is stuff that the bench maintainers have very little control over. That might be why they’re still installing direct from repo in the install.py script.