python-certbot-apache-doc 0.23.0-1 / usr / share / doc / python3-certbot-apache / html / searchindex.js

Search.setIndex({docnames:["api","api/augeas_configurator","api/configurator","api/display_ops","api/obj","api/parser","api/tls_sni_01","index"],envversion:53,filenames:["api.rst","api/augeas_configurator.rst","api/configurator.rst","api/display_ops.rst","api/obj.rst","api/parser.rst","api/tls_sni_01.rst","index.rst"],objects:{"":{certbot_apache:[7,0,0,"-"]},"certbot_apache.augeas_configurator":{AugeasConfigurator:[1,1,1,""]},"certbot_apache.augeas_configurator.AugeasConfigurator":{_log_save_errors:[1,2,1,""],check_parsing_errors:[1,2,1,""],ensure_augeas_state:[1,2,1,""],init_augeas:[1,2,1,""],recovery_routine:[1,2,1,""],revert_challenge_config:[1,2,1,""],rollback_checkpoints:[1,2,1,""],save:[1,2,1,""],unsaved_files:[1,2,1,""]},"certbot_apache.configurator":{ApacheConfigurator:[2,1,1,""]},"certbot_apache.configurator.ApacheConfigurator":{_add_listens_http:[2,2,1,""],_add_listens_https:[2,2,1,""],_add_name_vhost_if_necessary:[2,2,1,""],_add_servernames:[2,2,1,""],_check_aug_version:[2,2,1,""],_choose_vhosts_wildcard:[2,2,1,""],_copy_create_ssl_vhost_skeleton:[2,2,1,""],_create_redirect_vhost:[2,2,1,""],_create_vhost:[2,2,1,""],_deploy_cert:[2,2,1,""],_enable_ocsp_stapling:[2,2,1,""],_enable_redirect:[2,2,1,""],_find_best_vhost:[2,2,1,""],_get_http_vhost:[2,2,1,""],_get_new_vh_path:[2,2,1,""],_get_proposed_addrs:[2,2,1,""],_get_ssl_vhost_path:[2,2,1,""],_get_vhost_block:[2,2,1,""],_get_vhost_names:[2,2,1,""],_has_matching_wildcard:[2,2,1,""],_has_port_already:[2,2,1,""],_in_wildcard_scope:[2,2,1,""],_is_rewrite_engine_on:[2,2,1,""],_is_rewrite_exists:[2,2,1,""],_non_default_vhosts:[2,2,1,""],_reload:[2,2,1,""],_remove_closing_vhost_tag:[2,2,1,""],_set_http_header:[2,2,1,""],_sift_rewrite_rule:[2,2,1,""],_sift_rewrite_rules:[2,2,1,""],_verify_no_certbot_redirect:[2,2,1,""],_verify_no_matching_http_header:[2,2,1,""],_vhosts_for_wildcard:[2,2,1,""],_wildcard_domain:[2,2,1,""],add_name_vhost:[2,2,1,""],choose_vhost:[2,2,1,""],choose_vhosts:[2,2,1,""],cleanup:[2,2,1,""],config_test:[2,2,1,""],constant:[2,2,1,""],deploy_cert:[2,2,1,""],enable_mod:[2,2,1,""],enable_site:[2,2,1,""],enhance:[2,2,1,""],ensure_listen:[2,2,1,""],find_best_http_vhost:[2,2,1,""],get_all_names:[2,2,1,""],get_chall_pref:[2,2,1,""],get_name_from_ip:[2,2,1,""],get_parser:[2,2,1,""],get_version:[2,2,1,""],get_virtual_hosts:[2,2,1,""],included_in_wildcard:[2,2,1,""],install_ssl_options_conf:[2,2,1,""],is_name_vhost:[2,2,1,""],make_addrs_sni_ready:[2,2,1,""],make_vhost_ssl:[2,2,1,""],mod_ssl_conf:[2,3,1,""],more_info:[2,2,1,""],perform:[2,2,1,""],prepare:[2,2,1,""],prepare_https_modules:[2,2,1,""],prepare_server_https:[2,2,1,""],restart:[2,2,1,""],supported_enhancements:[2,2,1,""],updated_mod_ssl_conf_digest:[2,3,1,""]},"certbot_apache.display_ops":{_reversemap_vhosts:[3,4,1,""],_vhost_menu:[3,4,1,""],select_vhost:[3,4,1,""],select_vhost_multiple:[3,4,1,""]},"certbot_apache.obj":{Addr:[4,1,1,""],VirtualHost:[4,1,1,""]},"certbot_apache.obj.Addr":{_addr_less_specific:[4,2,1,""],_rank_specific_addr:[4,2,1,""],conflicts:[4,2,1,""],get_sni_addr:[4,2,1,""],is_wildcard:[4,2,1,""]},"certbot_apache.obj.VirtualHost":{conflicts:[4,2,1,""],display_repr:[4,2,1,""],get_names:[4,2,1,""],same_server:[4,2,1,""]},"certbot_apache.parser":{ApacheParser:[5,1,1,""],case_i:[5,4,1,""],get_aug_path:[5,4,1,""]},"certbot_apache.parser.ApacheParser":{_add_httpd_transform:[5,2,1,""],_check_path_actions:[5,2,1,""],_exclude_dirs:[5,2,1,""],_find_config_root:[5,2,1,""],_get_ifmod:[5,2,1,""],_get_include_path:[5,2,1,""],_get_runtime_cfg:[5,2,1,""],_parsed_by_parser_paths:[5,2,1,""],_pass_filter:[5,2,1,""],_remove_httpd_transform:[5,2,1,""],_set_locations:[5,2,1,""],add_dir:[5,2,1,""],add_dir_beginning:[5,2,1,""],add_dir_to_ifmodssl:[5,2,1,""],add_include:[5,2,1,""],add_mod:[5,2,1,""],filter_args_num:[5,2,1,""],find_dir:[5,2,1,""],fnmatch_to_re:[5,2,1,""],get_arg:[5,2,1,""],parse_file:[5,2,1,""],parse_from_subprocess:[5,2,1,""],parse_modules:[5,2,1,""],parsed_in_current:[5,2,1,""],parsed_in_original:[5,2,1,""],reset_modules:[5,2,1,""],standardize_excl:[5,2,1,""],update_defines:[5,2,1,""],update_includes:[5,2,1,""],update_modules:[5,2,1,""],update_runtime_variables:[5,2,1,""]},"certbot_apache.tls_sni_01":{ApacheTlsSni01:[6,1,1,""]},"certbot_apache.tls_sni_01.ApacheTlsSni01":{_get_addrs:[6,2,1,""],_get_config_text:[6,2,1,""],_mod_config:[6,2,1,""],perform:[6,2,1,""]},certbot_apache:{augeas_configurator:[1,0,0,"-"],configurator:[2,0,0,"-"],display_ops:[3,0,0,"-"],obj:[4,0,0,"-"],parser:[5,0,0,"-"],tls_sni_01:[6,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","class","Python class"],"2":["py","method","Python method"],"3":["py","attribute","Python attribute"],"4":["py","function","Python function"]},objtypes:{"0":"py:module","1":"py:class","2":"py:method","3":"py:attribute","4":"py:function"},terms:{"boolean":2,"case":[2,5],"class":[1,2,4,5,6],"default":[2,4,5],"final":2,"function":[1,2,3,4,5],"int":[1,4,5],"new":[1,2,5],"return":[1,2,3,4,5,6],"true":[2,4,5],"try":[4,5],"while":5,DNS:2,For:2,Not:[2,5],TLS:[2,6],The:[1,2,4,5],Used:[1,2,4],Uses:5,_add_httpd_transform:5,_add_listens_http:2,_add_name_vhost_if_necessari:2,_add_servernam:2,_addr_less_specif:4,_check_aug_vers:2,_check_path_act:5,_choose_vhosts_wildcard:2,_copy_create_ssl_vhost_skeleton:2,_create_redirect_vhost:2,_create_vhost:2,_default_:[2,4],_deploy_cert:2,_enable_ocsp_stapl:2,_enable_redirect:2,_exclude_dir:5,_find_best_vhost:2,_find_config_root:5,_get_addr:6,_get_config_text:6,_get_http_vhost:2,_get_ifmod:5,_get_include_path:5,_get_new_vh_path:2,_get_proposed_addr:2,_get_runtime_cfg:5,_get_ssl_vhost_path:2,_get_vhost_block:2,_get_vhost_nam:2,_has_matching_wildcard:2,_has_port_alreadi:2,_in_wildcard_scop:2,_is_rewrite_engine_on:2,_is_rewrite_exist:2,_log_save_error:1,_mod_config:6,_non_default_vhost:2,_parsed_by_parser_path:5,_pass_filt:5,_rank_specific_addr:4,_reload:2,_remove_closing_vhost_tag:2,_remove_httpd_transform:5,_reversemap_vhost:3,_set_http_head:2,_set_loc:5,_sift_rewrite_rul:2,_verify_no_certbot_redirect:2,_verify_no_matching_http_head:2,_vhost_menu:3,_vhosts_for_wildcard:2,_wildcard_domain:2,abl:5,about:6,abov:2,absolut:[2,5],accept:2,accord:1,achal:[2,6],action:[2,5],activ:2,actual:[1,2,3],adapt:5,add:[2,5],add_dir:5,add_dir_begin:5,add_dir_to_ifmodssl:5,add_includ:5,add_mod:5,add_name_vhost:2,add_transform:5,added:[2,5],adding:2,addit:1,addr:[2,4,6],address:[2,4,6],after:[2,5],alias:[2,4],all:[1,2,4,5,6],allow:[2,5],along:5,alreadi:2,also:[2,5],ancestor:4,ani:[2,4,5],annot:6,apach:[2,3,4,5,6],apache2:5,apacheconfigur:[1,2,5,6],apachepars:[2,5],apachetlssni01:6,api:7,appear:5,append:5,appropri:[2,3,5],apr:5,apr__fnmatch_8h_sourc:5,arg:[1,2,5,6],argument:[2,5],arrai:6,assoc:2,associ:2,assum:[2,5],assumpt:5,attempt:[1,2,5],aug:[1,5],aug_conf_path:5,augea:[1,2,4,5],augeas_configur:[0,2],augeasconfigur:[1,2,5],authent:2,avail:[2,3,5],avoid:[1,5],awai:4,back:[2,3],bad:1,base:[1,2,4,5,6],basic:5,becaus:[2,5],been:[1,2],befor:1,begin:5,being:2,belong:6,best:2,better:2,between:2,binari:5,block:[2,5],bool:[1,2,4,5],both:2,browser:2,built:2,cach:2,call:5,can:[1,2],cannot:2,canon:2,capabl:6,card:2,care:2,case_i:5,caus:[1,2,6],cert_path:2,certbot:[1,2,4,6],certbot_apach:0,certif:[2,3],chain:2,chain_path:2,chall:6,challeng:[1,2,6],challenge_conf:6,chang:[1,2],check:[1,2,5],check_parsing_error:1,checkpoint:1,chocol:6,choic:2,choos:2,choose_vhost:2,chosen:2,clean_fn_match:5,cleanup:[1,2,5],clear:[2,5],client:2,close:2,code:[2,3],collect:2,com:5,combin:4,come:5,command:5,common:[1,4,6],compar:2,compat:[2,5],conf:2,config:[1,2,5,6],config_test:2,configur:[0,1,4,5,6],conflict:4,consid:[2,5],constant:2,contain:[2,3,4,5],content:[2,7],convert:5,copi:2,core:2,correct:[2,4],correctli:[1,2,5],could:4,counterpart:2,cover:2,creat:[1,2,5],create_if_no_ssl:2,create_ssl:2,current:[2,5],data:5,debug:2,decid:2,defin:[2,5],delet:2,depend:[2,5],deploi:2,deploy:2,deploy_cert:2,deprec:2,design:2,desir:[2,4,5],destin:2,detail:[4,5],determin:[2,4,5],dialog:4,dict:[2,5],differ:4,digest:2,dir:2,direct:[1,2,5],directli:2,directori:[1,5],dirnam:5,disabl:2,displai:3,display_op:0,display_repr:4,distribut:2,dns:2,doc:[2,4,5],document:[2,5],doe:[2,5],doesn:[2,5],doing:1,dom:[1,5],domain:[2,3,4,6],don:2,done:[2,5],due:[1,2],dump:5,duplic:2,dure:2,each:2,earlier:2,either:2,els:5,empti:2,enabl:[2,4,5],enable_mod:2,enable_sit:2,end:[2,5],enhanc:2,enough:2,ensure_augeas_st:1,ensure_listen:2,entri:2,equival:2,error:[1,2],escap:5,especi:2,etc:5,everi:2,everyth:[2,5],ex_err:1,exact:[2,4],exampl:[2,4],except:1,excl:5,exclud:5,exist:[1,2,5],express:5,extract:2,fail:2,fall:2,fals:[1,2,4],fashion:2,figur:2,file:[1,2,4,5,6],file_path:5,filenam:5,filep:[4,5],filepath:[2,5],filesystem:[1,2],filter:5,filter_:5,filter_args_num:5,filter_default:2,find:[2,5],find_best_http_vhost:2,find_dir:5,fine:5,first:[1,2],fix:5,flag:4,fnmatch:5,fnmatch_to_r:5,form:[2,5],found:[1,2,5],from:[2,5],fulfil:2,full:[2,5],fullchain_path:2,futur:[1,2],gener:[2,4,5],general_vhost:2,get:[2,5],get_addr:4,get_all_nam:2,get_arg:5,get_aug_path:5,get_chall_pref:2,get_nam:4,get_name_from_ip:2,get_pars:2,get_sni_addr:4,get_vers:2,get_virtual_host:2,give:5,given:[1,2,4,5],glob:5,grace:2,guarante:2,hack:5,hand:2,handl:[2,4,5],happen:2,has:[1,2,4],have:[1,2,5],header:2,header_substr:2,help:2,helper:[2,3,5],hold:6,host:[2,3,4,6],howev:5,html:[2,4,5],http:[2,4,5,6],http_header:2,http_vhost:2,httpd:[2,4,5],human:[1,2],ident:2,identifi:2,ifmod:5,ifmodul:2,imagin:6,immedi:5,implicitli:2,inc_path:5,incl:5,includ:[2,4,5,6],included_in_wildcard:2,includeopt:5,incorrect:5,index:[6,7],indic:[1,2,4,6],info:5,inher:5,init_augea:1,initi:[1,2],input:1,insecur:2,insensit:[2,5],instal:[1,2,3],install_ssl_options_conf:2,instanc:1,instead:2,interpret:5,invalid:2,ip_addr:6,ipv6:4,is_name_vhost:2,is_wildcard:4,isn:[2,5],issu:[5,6],iter:[2,4,5],its:2,join:5,kei:2,key_path:2,keyauthorizationannotatedchalleng:6,kwarg:[1,2,6],lack:2,larger:6,last:2,layout:2,le_vhost_ext:2,least:4,leav:2,len:[1,5],level:2,libaugea:[2,5],like:5,line:2,linear:5,list:[1,2,3,4,5,6],listen:[2,5],listens_orig:2,live:5,load:[1,2,5],loc:5,locat:[2,5,6],log:1,look:5,loop:2,loss:1,lot:2,low:2,lowercas:5,made:[1,5],magic:4,mai:5,main:[4,5],main_config:5,maintain:[5,6],make:[1,2,5],make_addrs_sni_readi:2,make_vhost_ssl:2,mani:6,map:[2,3],match:[2,4,5],meant:6,member:5,method:[2,3,5],might:2,misconfigur:2,misconfigurationerror:2,mod:[2,5],mod_macro:4,mod_nam:[2,5],mod_ssl:[2,5],mod_ssl_conf:2,modifi:[1,2,6],modmacro:4,modul:[2,4,5,7],more:[2,4,5],more_info:2,most:[2,5],multipl:[2,3],must:[5,6],name:[2,3,4,5],namevirtualhost:[2,5],narrow:5,necessari:[2,5],need:[2,5,6],new_match:2,newli:2,nice:2,node:5,noinstallationerror:2,non:[2,4],non_ssl_vh_fp:2,none:[1,2,3,4,5],nonssl_vhost:2,normal:[2,5],note:[1,5],notsupportederror:2,now:2,number:[1,2,5],numer:4,obj:[0,2,3],object:[1,2,3,4,5,6],ocsp:2,off:[2,5],offer:2,old:[2,5],onc:[5,6],one:[2,5],onli:[2,5],oper:3,option:[2,6],options_ssl:2,options_ssl_digest:2,order:[5,6],org:[2,4,5],orig_match:2,origin:[2,5],os_default:2,other:2,otherwis:2,out:[2,5],output:5,outstand:2,over:2,overrid:2,overwrit:4,own:5,page:7,param:5,paramet:[1,2,3,4,5,6],pars:[1,2,5],parse_fil:5,parse_from_subprocess:5,parse_modul:5,parsed_in_curr:5,parsed_in_origin:5,parser:[0,2],pass:[2,5],path:[2,4,5],per:2,perform:[2,6],perman:2,place:[2,5],plugin:[1,2,4,6,7],pluginenhancementalreadypres:2,pluginerror:[1,2],point:2,popular:5,port:[2,4],posit:2,possibl:1,prefer:2,prepar:2,prepare_https_modul:2,prepare_server_http:2,present:2,previous:1,prioriti:2,privileg:5,probabl:5,problem:[1,2,5],process:5,progress:2,prompt:2,proper:5,provid:[2,4,5],put:1,python:5,qsa:2,queri:2,question:2,quickli:1,quot:5,rais:[1,2],rank:4,read:2,readabl:[1,2],readi:2,recent:2,recov:1,recovery_routin:1,recurs:5,redireciton:2,redirect:[2,4],regex:5,regexp:[2,5],regular:5,relat:[2,5],relev:5,reload:[2,5],remov:[2,5],replac:[2,5],repres:4,represent:[3,4],request:2,request_uri:2,requir:2,reset:[1,5],reset_modul:5,resid:2,resolv:4,respond:2,respons:[2,6],restart:2,result:[1,2,5,6],revers:[1,2],revert:[1,2],revert_challenge_config:1,revok:2,rewrit:2,rewriteengin:2,rewriterul:2,rewritten:2,rollback:1,rollback_checkpoint:1,root:5,rule:2,run:[2,5],runtim:5,same:[2,4,5],same_serv:4,save:[1,2],save_not:1,scope:2,search:[2,5,7],searchabl:5,secur:2,see:[2,4,5],seem:5,select:[2,3],select_vhost:3,select_vhost_multipl:3,self:[1,2,4,5],sensit:5,serv:[2,4],server:[2,4,5,6],server_nam:2,serveralia:2,serveralias:2,servernam:[2,4],servic:4,set:[1,2,4,5,6],shortcut:5,should:[2,5],shouldn:2,sift:2,similar:2,singl:2,site:[2,5],skeleton:2,slash:5,sloppi:5,sni:[2,6],solv:6,sometim:5,sourc:[1,2,3,4,5,6],sourcearch:5,span:2,specif:[2,4,5],specifi:[1,2],ssl:[2,4,5],ssl_fp:2,ssl_modul:2,ssl_vhost:2,sslcertificatechainfil:2,sslengin:[2,4],standard:5,standardize_excl:5,stapl:2,start:[2,5],state:[1,2,6],statement:[2,5],stdout:5,str:[1,2,4,5,6],strict:2,string:[2,3,5],strip:5,style:5,submit:5,subprocess:5,success:2,suitabl:5,support:[2,5],supported_enhanc:2,sure:[1,2,5],system:2,tag:[2,3],take:[2,4,5],target:2,target_addr:2,target_nam:2,temp:2,temporari:[1,2],temporarili:[2,5],test:2,text:6,than:[2,4],them:[2,5],thi:[1,2,4,5,6],though:2,three:2,through:5,thu:5,time:5,timestamp:1,titl:1,tls_sni_01:0,tlssni01:6,traffic:2,trail:5,transform:5,transit:2,transport:2,travi:5,tree:5,tri:2,tup:[2,4],tupl:[2,3,5],turn:2,two:4,type:[2,3,4,5,6],ubuntu:[2,5],unabl:[1,2],uncondition:2,understand:2,unfortun:[2,5],uniqu:2,unless:2,unsav:1,unsaved_fil:1,until:5,unused_domain:2,unused_opt:2,updat:[2,5],update_defin:5,update_includ:5,update_modul:5,update_runtime_vari:5,updated_mod_ssl_conf_digest:2,upgrad:2,use:5,used:[1,2,4,6],user:[2,5],uses:2,using:4,util:6,valid:2,valu:[2,5],variabl:[1,2,4,5,6],verifi:[1,2],version:[2,5],vh_content:2,vh_path:2,vhost:[2,3,4,6],vhost_path:2,vhostroot:5,viabl:2,virtual:[2,3,4,6],virtualhost:[2,3,4],want:2,web:2,well:5,when:[1,2],where:[2,6],whether:[1,2,4,5],which:[2,6],who:6,whose:2,wide:5,wild:2,wildcard:[2,4],within:[2,4,5,6],without:[2,5],work:[2,5],would:[2,4,5],writabl:5,write:2,writerul:2,written:1,yet:1,you:5},titles:["API Documentation","<code class=\"docutils literal\"><span class=\"pre\">certbot_apache.augeas_configurator</span></code>","<code class=\"docutils literal\"><span class=\"pre\">certbot_apache.configurator</span></code>","<code class=\"docutils literal\"><span class=\"pre\">certbot_apache.display_ops</span></code>","<code class=\"docutils literal\"><span class=\"pre\">certbot_apache.obj</span></code>","<code class=\"docutils literal\"><span class=\"pre\">certbot_apache.parser</span></code>","<code class=\"docutils literal\"><span class=\"pre\">certbot_apache.tls_sni_01</span></code>","Welcome to certbot-apache\u2019s documentation!"],titleterms:{apach:7,api:0,augeas_configur:1,certbot:7,certbot_apach:[1,2,3,4,5,6],configur:2,display_op:3,document:[0,7],indic:7,obj:4,parser:5,tabl:7,tls_sni_01:6,todo:[2,4,5],welcom:7}})